org.springframework.xd.shell

Class Target

java.lang.Object

org.springframework.xd.shell.Target

public class Target
extends java.lang.Object

Encapsulates various data points related to the Admin Server Target, such as target URI, success/error state, exception messages that may have occurred.

Since:

1.0

Author:

Gunnar Hillert

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Target.Credentials
static class	Target.TargetStatus

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_HOST
static int	DEFAULT_PORT
static java.lang.String	DEFAULT_SCHEME
static java.lang.String	DEFAULT_SPECIFIED_PASSWORD
static java.lang.String	DEFAULT_TARGET
static java.lang.String	DEFAULT_UNSPECIFIED_PASSWORD
static java.lang.String	DEFAULT_USERNAME

Constructor Summary

Constructors

Constructor and Description
Target(java.lang.String targetUriAsString) Construct a new Target.
Target(java.lang.String targetUriAsString, java.lang.String targetUsername, java.lang.String targetPassword) Construct a new Target.

Method Summary

Methods

Modifier and Type	Method and Description
Target.TargetStatus	getStatus() Return the target status, which is either Success or Error.
Target.Credentials	getTargetCredentials() Returns the target credentials
java.lang.Exception	getTargetException() If during targeting an error occurred, the resulting Exception is made available for further introspection.
java.lang.String	getTargetResultMessage() Provides a result message indicating whether the provide getTargetUri() was successfully targeted or not.
java.net.URI	getTargetUri()
java.lang.String	getTargetUriAsString() Returns the target URI as a String.
void	setTargetException(java.lang.Exception targetException) Sets the exception in case an error occurred during targeting.
void	setTargetResultMessage(java.lang.String targetResultMessage) Set the result messages indicating the success or failure while targeting the Spring XD Admin Server.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_SCHEME

public static final java.lang.String DEFAULT_SCHEME

See Also:

Constant Field Values

DEFAULT_HOST

public static final java.lang.String DEFAULT_HOST

See Also:

Constant Field Values

DEFAULT_PORT

public static final int DEFAULT_PORT

See Also:

Constant Field Values

DEFAULT_USERNAME

public static final java.lang.String DEFAULT_USERNAME

See Also:

Constant Field Values

DEFAULT_SPECIFIED_PASSWORD

public static final java.lang.String DEFAULT_SPECIFIED_PASSWORD

See Also:

Constant Field Values

DEFAULT_UNSPECIFIED_PASSWORD

public static final java.lang.String DEFAULT_UNSPECIFIED_PASSWORD

See Also:

Constant Field Values

DEFAULT_TARGET

public static final java.lang.String DEFAULT_TARGET

See Also:

Constant Field Values

Constructor Detail

Target

public Target(java.lang.String targetUriAsString,
      java.lang.String targetUsername,
      java.lang.String targetPassword)

Construct a new Target. The passed in targetUriAsString String parameter will be converted to a URI. This method allows for providing a username and password for authentication.

Parameters:

targetUriAsString - Must not be empty

targetUsername - May be empty, if access is unauthenticated

targetPassword - May be empty

Throws:

java.lang.IllegalArgumentException - if the given string violates RFC 2396.

Target

public Target(java.lang.String targetUriAsString)

Construct a new Target. The passed in targetUriAsString String parameter will be converted to a URI.

Parameters:

targetUriAsString - Must not be empty

Throws:

java.lang.IllegalArgumentException - if the given string violates RFC 2396

Method Detail

getStatus

public Target.TargetStatus getStatus()

Return the target status, which is either Success or Error.

Returns:

The Target.TargetStatus. May be null.

getTargetException

public java.lang.Exception getTargetException()

If during targeting an error occurred, the resulting Exception is made available for further introspection.

Returns:

If present, returns the Exception, otherwise null is returned.

getTargetResultMessage

public java.lang.String getTargetResultMessage()

Provides a result message indicating whether the provide getTargetUri() was successfully targeted or not.

Returns:

The formatted result message.

getTargetUri

public java.net.URI getTargetUri()

Returns:

The Target Uri. Will never be null.

getTargetUriAsString

public java.lang.String getTargetUriAsString()

Returns the target URI as a String.

Returns:

Never null and will always return a valid URI value

getTargetCredentials

public Target.Credentials getTargetCredentials()

Returns the target credentials

Returns:

The target credentials. May be null if there is no authentication

setTargetException

public void setTargetException(java.lang.Exception targetException)

Sets the exception in case an error occurred during targeting. Will also set the respective Target.TargetStatus to Target.TargetStatus.ERROR.

Parameters:

targetException - Must not be null.

setTargetResultMessage

public void setTargetResultMessage(java.lang.String targetResultMessage)

Set the result messages indicating the success or failure while targeting the Spring XD Admin Server.

Parameters:

targetResultMessage - Must not be empty.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object