Paths (Spring XD 1.2.1.RELEASE API)

java.lang.Object
- org.springframework.xd.dirt.zookeeper.Paths

```
public class Paths
extends java.lang.Object
```
Common paths and path utilities for XD components.

Author:

Patrick Peralta, David Turanski

Field Summary

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`ADMINELECTION` Name of admins (that could participate to become leader) node.
`static java.lang.String`	`ADMINS` Name of admins node.
`static java.lang.String`	`ALLOCATED` Name of the deployment modules node that are allocated to containers.
`static java.lang.String`	`CONTAINERS` Name of containers node.
`static java.lang.String`	`DEPLOYMENT_QUEUE` Name of the stream deployment queue path.
`static java.lang.String`	`DEPLOYMENTS` Name of deployments node.
`static java.lang.String`	`JOB_DEPLOYMENTS` Name of job deployments node.
`static java.lang.String`	`JOBS` Name of jobs node.
`static java.lang.String`	`METADATA` Name of metadata node.
`static java.lang.String`	`MODULE_DEPLOYMENTS` Name of module deployments node.
`static java.lang.String`	`MODULES` Name of modules node.
`static java.lang.String`	`QUEUE` Name of the queue node.
`static java.lang.String`	`REQUESTED` Name of the module deployment requests node.
`static java.lang.String`	`RESPONSES` Name of the parent node for deployment request responses.
`static java.lang.String`	`STATUS` Name of status node.
`static java.lang.String`	`STREAM_DEPLOYMENTS` Name of stream deployments node.
`static java.lang.String`	`STREAMS` Name of streams node.
`static java.lang.String`	`TAPS` Name of taps node.
`static java.lang.String`	`XD_NAMESPACE` Namespace path (i.e.

Constructor Summary

Constructors
Constructor and Description

Paths()

Constructors
Constructor and Description
`Paths()`

Method Summary

Methods
Modifier and Type	Method and Description
`static java.lang.String`	`build(java.lang.String... elements)` Return a string with the provided path elements separated by a slash `/`.
`static void`	`ensurePath(org.apache.curator.framework.CuratorFramework client, java.lang.String path)` Ensure the existence of the given path.
`static java.lang.String`	`stripPath(java.lang.String path)` Strip path information from a string.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - XD_NAMESPACE
```
public static final java.lang.String XD_NAMESPACE
```
    Namespace path (i.e. the top node in the hierarchy) for XD nodes.
    
    See Also:
    Constant Field Values
  - ADMINELECTION
```
public static final java.lang.String ADMINELECTION
```
    Name of admins (that could participate to become leader) node. Admin lock nodes are written as children of this node. This node is solely used from curator.
    
    See Also:
    Constant Field Values
  - ADMINS
```
public static final java.lang.String ADMINS
```
    Name of admins node. Containers are written as children of this node. Used to store admin metadata while curator election is handled under adminelection.
    
    See Also:
    Constant Field Values
  - CONTAINERS
```
public static final java.lang.String CONTAINERS
```
    Name of containers node. Containers are written as children of this node.
    
    See Also:
    Constant Field Values
  - MODULES
```
public static final java.lang.String MODULES
```
    Name of modules node. Module definitions are written as children of this node.
    
    See Also:
    Constant Field Values
  - STREAMS
```
public static final java.lang.String STREAMS
```
    Name of streams node. Streams are written as children of this node.
    
    See Also:
    Constant Field Values
  - JOBS
```
public static final java.lang.String JOBS
```
    Name of jobs node. Jobs are written as children of this node.
    
    See Also:
    Constant Field Values
  - TAPS
```
public static final java.lang.String TAPS
```
    Name of taps node. Channel names with active taps are written as children of this node.
    
    See Also:
    Constant Field Values
  - DEPLOYMENTS
```
public static final java.lang.String DEPLOYMENTS
```
    Name of deployments node. Deployments are written as children of this node.
    
    See Also:
    Constant Field Values
  - ALLOCATED
```
public static final java.lang.String ALLOCATED
```
    Name of the deployment modules node that are allocated to containers. Allocated modules are written as children of this node.
    
    See Also:
    Constant Field Values
  - METADATA
```
public static final java.lang.String METADATA
```
    Name of metadata node. The data for this node contains ModuleMetadata.
    
    See Also:
    Constant Field Values
  - REQUESTED
```
public static final java.lang.String REQUESTED
```
    Name of the module deployment requests node. Requested modules are written as children of this node.
    
    See Also:
    Constant Field Values
  - STATUS
```
public static final java.lang.String STATUS
```
    Name of status node. The data for this node contains status information.
    
    See Also:
    Constant Field Values
  - QUEUE
```
public static final java.lang.String QUEUE
```
    Name of the queue node.
    
    See Also:
    Constant Field Values
  - RESPONSES
```
public static final java.lang.String RESPONSES
```
    Name of the parent node for deployment request responses.
    
    See Also:
    Constant Field Values
  - MODULE_DEPLOYMENTS
```
public static final java.lang.String MODULE_DEPLOYMENTS
```
    Name of module deployments node. Module deployment requests for individual containers are written as children of this node.
    
    See Also:
    Constant Field Values
  - STREAM_DEPLOYMENTS
```
public static final java.lang.String STREAM_DEPLOYMENTS
```
    Name of stream deployments node. Stream deployment requests are written as children of this node.
    
    See Also:
    Constant Field Values
  - JOB_DEPLOYMENTS
```
public static final java.lang.String JOB_DEPLOYMENTS
```
    Name of job deployments node. Job deployment requests are written as children of this node.
    
    See Also:
    Constant Field Values
  - DEPLOYMENT_QUEUE
```
public static final java.lang.String DEPLOYMENT_QUEUE
```
    Name of the stream deployment queue path.
    
    See Also:
    Constant Field Values
- Constructor Detail
  - Paths
```
public Paths()
```
- Method Detail
  - stripPath
```
public static java.lang.String stripPath(java.lang.String path)
```
    Strip path information from a string. For example, given an input of /xd/path/location, return location.
    
    Parameters:
    path - path string
    
    Returns:
    string with path stripped
  - build
```
public static java.lang.String build(java.lang.String... elements)
```
    Return a string with the provided path elements separated by a slash /. The leading slash is created if required.
    
    Parameters:
    elements - path elements
    
    Returns:
    the full path
  - ensurePath
```
public static void ensurePath(org.apache.curator.framework.CuratorFramework client,
              java.lang.String path)
```
    Ensure the existence of the given path.
    
    Parameters:
    client - curator client
    path - path to create, if needed

Class Paths

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

XD_NAMESPACE

ADMINELECTION

ADMINS

CONTAINERS

MODULES

STREAMS

JOBS

TAPS

DEPLOYMENTS

ALLOCATED

METADATA

REQUESTED

STATUS

QUEUE

RESPONSES

MODULE_DEPLOYMENTS

STREAM_DEPLOYMENTS

JOB_DEPLOYMENTS

DEPLOYMENT_QUEUE

Constructor Detail

Paths

Method Detail

stripPath

build

ensurePath