net.dpml.transit.info
Class HostDirective

java.lang.Object
  net.dpml.lang.AbstractDirective
      net.dpml.transit.info.HostDirective

All Implemented Interfaces:

Serializable

public class HostDirective

extends AbstractDirective

Description of a host configuration within Transit.

Version:

1.0.0

Author:

The Digital Product Meta Library

See Also:

Serialized Form

Constructor Summary

HostDirective(String id, int priority, String host, String index, String username, char[] password, boolean enabled, boolean trusted, String layout, String scheme, String prompt)
Creation of a new host description.

Method Summary

boolean	equals(Object other) Compare this instance with a supplied object for equality.
boolean	getEnabled() Return the enabled status.
String	getHost() Return the resource host.
String	getID() Return the host identifier.
String	getIndex() Return the index resource name.
String	getLayout() Return the layout name.
char[]	getPassword() Return the proxy password.
int	getPriority() Return the host priority.
String	getPrompt() Return the authentication prompt.
String	getScheme() Return the authentication scheme.
boolean	getTrusted() Return the trusted status.
String	getUsername() Return the proxy username.
int	hashCode() Compute the instance hashcode value.

Methods inherited from class net.dpml.lang.AbstractDirective

equals, hashArray, hashValue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HostDirective

public HostDirective(String id,
                     int priority,
                     String host,
                     String index,
                     String username,
                     char[] password,
                     boolean enabled,
                     boolean trusted,
                     String layout,
                     String scheme,
                     String prompt)
              throws NullPointerException

Creation of a new host description.

Parameters:

id - a unique resource host identifier

priority - the host prority

host - the resource host

index - the name of an index resource (may be null)

username - a possibly null username

password - a possibly null password

enabled - true if enabled

trusted - true if trusted

layout - the name of the layout strategy

scheme - the security scheme (may be null)

prompt - authentication prompt (may be null)

Throws:

NullPointerException - if the id, host, or layout are null

Method Detail

getID

public String getID()

Return the host identifier.

Returns:

the host id

getPriority

public int getPriority()

Return the host priority.

Returns:

the host priority value

getHost

public String getHost()

Return the resource host.

Returns:

the host

getIndex

public String getIndex()

Return the index resource name.

Returns:

the host index resource name

getUsername

public String getUsername()

Return the proxy username.

Returns:

the poxy username

getPassword

public char[] getPassword()

Return the proxy password.

Returns:

the poxy password

getEnabled

public boolean getEnabled()

Return the enabled status.

Returns:

true if enabled

getTrusted

public boolean getTrusted()

Return the trusted status.

Returns:

true if trusted

getLayout

public String getLayout()

Return the layout name.

Returns:

the layout key

getPrompt

public String getPrompt()

Return the authentication prompt.

Returns:

the layout key

getScheme

public String getScheme()

Return the authentication scheme.

Returns:

the scheme

equals

public boolean equals(Object other)

Compare this instance with a supplied object for equality.

Overrides:

equals in class AbstractDirective

Parameters:

other - the other object

Returns:

true if the supplied instance is equal to this instance

hashCode

public int hashCode()

Compute the instance hashcode value.

Overrides:

hashCode in class AbstractDirective

Returns:

the hashcode