Document magic number in NodeMetadata for Docker
Project: http://git-wip-us.apache.org/repos/asf/jclouds-labs/repo Commit: http://git-wip-us.apache.org/repos/asf/jclouds-labs/commit/911d5c57 Tree: http://git-wip-us.apache.org/repos/asf/jclouds-labs/tree/911d5c57 Diff: http://git-wip-us.apache.org/repos/asf/jclouds-labs/diff/911d5c57 Branch: refs/heads/master Commit: 911d5c5712567a6e07ed9d560ca83ca62807cccd Parents: a4d61fb Author: Andrew Kennedy <[email protected]> Authored: Fri Oct 10 21:19:57 2014 +0100 Committer: Andrew Kennedy <[email protected]> Committed: Fri Oct 10 21:19:57 2014 +0100 ---------------------------------------------------------------------- .../docker/compute/functions/ContainerToNodeMetadata.java | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/jclouds-labs/blob/911d5c57/docker/src/main/java/org/jclouds/docker/compute/functions/ContainerToNodeMetadata.java ---------------------------------------------------------------------- diff --git a/docker/src/main/java/org/jclouds/docker/compute/functions/ContainerToNodeMetadata.java b/docker/src/main/java/org/jclouds/docker/compute/functions/ContainerToNodeMetadata.java index 580e5f1..3ec7f5c 100644 --- a/docker/src/main/java/org/jclouds/docker/compute/functions/ContainerToNodeMetadata.java +++ b/docker/src/main/java/org/jclouds/docker/compute/functions/ContainerToNodeMetadata.java @@ -48,6 +48,14 @@ import com.google.inject.Singleton; @Singleton public class ContainerToNodeMetadata implements Function<Container, NodeMetadata> { + /** + * This value is used when a container does not have an accessible + * login port (i.e. the SSH daemon is not running) due to being + * started outside jclouds. Client code should check for this value + * when accessing NodeMetadata from Docker. + */ + public static final Integer NO_LOGIN_PORT = Integer.valueOf(-1); + private final ProviderMetadata providerMetadata; private final Function<State, NodeMetadata.Status> toPortableStatus; private final GroupNamingConvention nodeNamingConvention; @@ -125,6 +133,6 @@ public class ContainerToNodeMetadata implements Function<Container, NodeMetadata } } } - return -1; + return NO_LOGIN_PORT; } }
