com.novell.db.object.bean
Class AuthenticationTestBean

java.lang.Object
  com.novell.sentinel.client.bean.SentinelBean
      com.novell.db.object.bean.AuthenticationTestBean

public class AuthenticationTestBean
extends SentinelBean

An automatically-generated "bean" class for the Sentinel data object type 'auth-test'.

The description of the type is:

"An AuthenticationTest object is used by an administrator to test the configuration of an authentication source. Typically this is used to validate LDAP settings and parameters when using an external LDAP directory as an authentication source for the Sentinel system."

The Sentinel data object bean classes are designed to be used to transport data to and from the Sentinel server. There exists a supporting infrastructure that handles the serialization/parsing of the data to/from the JSON transport format and which handles the actual HTTP transport.

A more complete description of Sentinel data object beans is found in the description of SentinelBean.

See Also:

SentinelBean, BeanTransporter

Field Summary

static String	AUTHENTICATIONCONFIG The "bean name" of the Sentinel data object field 'AuthenticationConfig'.
static String	PASSWORD The "bean name" of the Sentinel data object field 'Password'.
static String	USERNAME The "bean name" of the Sentinel data object field 'UserName'.

Constructor Summary

	AuthenticationTestBean() Construct an instance of the bean class.
protected	AuthenticationTestBean(BeanMetaData<? extends SentinelBean> metadata) Constructor for use by derived classes.

Method Summary

void	clearAuthenticationConfig() Clear any current value for the 'auth-config' field in the bean.
void	clearPassword() Clear any current value for the 'password' field in the bean.
void	clearUserName() Clear any current value for the 'user' field in the bean.
AuthenticationTestBean	clone() Create a duplicate of this bean instance, including all field values.
String	getAuthenticationConfig() Get the value for the 'auth-config' field.
static BeanMetaData<? extends AuthenticationTestBean>	getBeanMetaData() Get the metadata class instance for this type.
String	getPassword() Get the value for the 'password' field.
String	getUserName() Get the value for the 'user' field.
boolean	isAuthenticationConfigClear() Get whether the value for the 'auth-config' field is clear or not.
boolean	isAuthenticationConfigNull() Get whether the 'auth-config' field has been set to Null or not.
boolean	isPasswordClear() Get whether the value for the 'password' field is clear or not.
boolean	isPasswordNull() Get whether the 'password' field has been set to Null or not.
boolean	isUserNameClear() Get whether the value for the 'user' field is clear or not.
boolean	isUserNameNull() Get whether the 'user' field has been set to Null or not.
void	setAuthenticationConfig(String authenticationConfig) Set the value for the 'auth-config' field.
void	setAuthenticationConfigNull() Set to Null any current value for the 'auth-config' field in the bean.
void	setPassword(String password) Set the value for the 'password' field.
void	setPasswordNull() Set to Null any current value for the 'password' field in the bean.
void	setUserName(String userName) Set the value for the 'user' field.
void	setUserNameNull() Set to Null any current value for the 'user' field in the bean.

Methods inherited from class com.novell.sentinel.client.bean.SentinelBean

clearField, cloneBean, equals, fields, getBeanName, getBeanValue, getField, getFieldNoNull, getLink, getMetaData, isFieldClear, isFieldNull, isLinkClear, setField, setFieldNull, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

AUTHENTICATIONCONFIG

public static final String AUTHENTICATIONCONFIG

The "bean name" of the Sentinel data object field 'AuthenticationConfig'. The value is ""auth-config"".

The description of the 'auth-config' field is:

"The URL of the AuthenticationConfig object that is to be tested."

See Also:

Constant Field Values

USERNAME

public static final String USERNAME

The "bean name" of the Sentinel data object field 'UserName'. The value is ""user"".

The description of the 'user' field is:

"The name of the user account that is to be used in testing the authentication configuration."

See Also:

Constant Field Values

PASSWORD

public static final String PASSWORD

The "bean name" of the Sentinel data object field 'Password'. The value is ""password"".

The description of the 'password' field is:

"The password value that is to be used in testing the authentication configuration."

See Also:

Constant Field Values

Constructor Detail

AuthenticationTestBean

public AuthenticationTestBean()

Construct an instance of the bean class.

AuthenticationTestBean

protected AuthenticationTestBean(BeanMetaData<? extends SentinelBean> metadata)

Constructor for use by derived classes.

Parameters:

metadata - The metadata instance for the derived bean class. Normally this constructor will only be called by generated code.

Method Detail

getAuthenticationConfig

public String getAuthenticationConfig()

Get the value for the 'auth-config' field. The description of the 'auth-config' field is:

"The URL of the AuthenticationConfig object that is to be tested."

Returns:

The field's value in the bean instance, if any (may return null).

See Also:

AUTHENTICATIONCONFIG

isAuthenticationConfigNull

public boolean isAuthenticationConfigNull()

Get whether the 'auth-config' field has been set to Null or not. The description of the 'auth-config' field is:

"The URL of the AuthenticationConfig object that is to be tested."

See the description of Null values.

Returns:

true if the field value has been marked as null, false otherwise.

See Also:

setAuthenticationConfigNull(), AUTHENTICATIONCONFIG

isAuthenticationConfigClear

public boolean isAuthenticationConfigClear()

Get whether the value for the 'auth-config' field is clear or not. The description of the 'auth-config' field is:

"The URL of the AuthenticationConfig object that is to be tested."

See the description of cleared values.

Returns:

true if the field value has been cleared, false otherwise.

See Also:

clearAuthenticationConfig(), AUTHENTICATIONCONFIG

setAuthenticationConfig

public void setAuthenticationConfig(String authenticationConfig)

Set the value for the 'auth-config' field. The description of the 'auth-config' field is:

"The URL of the AuthenticationConfig object that is to be tested."

Parameters:

authenticationConfig - Value to set

See Also:

AUTHENTICATIONCONFIG

clearAuthenticationConfig

public void clearAuthenticationConfig()

Clear any current value for the 'auth-config' field in the bean. The description of the 'auth-config' field is:

"The URL of the AuthenticationConfig object that is to be tested."

Using this method will not clear the server value when the bean is PUT to the server. Use the setAuthenticationConfigNull() method to clear the server's value.

See the description of cleared values.

See Also:

AUTHENTICATIONCONFIG

setAuthenticationConfigNull

public void setAuthenticationConfigNull()

Set to Null any current value for the 'auth-config' field in the bean. The description of the 'auth-config' field is:

"The URL of the AuthenticationConfig object that is to be tested."

Using this method will clear the server value when the bean is PUT to the server. Use the clearAuthenticationConfig() method to avoid clearing the server's value.

See the description of Null values.

See Also:

AUTHENTICATIONCONFIG

getPassword

public String getPassword()

Get the value for the 'password' field. The description of the 'password' field is:

"The password value that is to be used in testing the authentication configuration."

Returns:

The field's value in the bean instance, if any (may return null).

See Also:

PASSWORD

isPasswordNull

public boolean isPasswordNull()

Get whether the 'password' field has been set to Null or not. The description of the 'password' field is:

"The password value that is to be used in testing the authentication configuration."

See the description of Null values.

Returns:

true if the field value has been marked as null, false otherwise.

See Also:

setPasswordNull(), PASSWORD

isPasswordClear

public boolean isPasswordClear()

Get whether the value for the 'password' field is clear or not. The description of the 'password' field is:

"The password value that is to be used in testing the authentication configuration."

See the description of cleared values.

Returns:

true if the field value has been cleared, false otherwise.

See Also:

clearPassword(), PASSWORD

setPassword

public void setPassword(String password)

Set the value for the 'password' field. The description of the 'password' field is:

"The password value that is to be used in testing the authentication configuration."

Parameters:

password - Value to set

See Also:

PASSWORD

clearPassword

public void clearPassword()

Clear any current value for the 'password' field in the bean. The description of the 'password' field is:

"The password value that is to be used in testing the authentication configuration."

Using this method will not clear the server value when the bean is PUT to the server. Use the setPasswordNull() method to clear the server's value.

See the description of cleared values.

See Also:

PASSWORD

setPasswordNull

public void setPasswordNull()

Set to Null any current value for the 'password' field in the bean. The description of the 'password' field is:

"The password value that is to be used in testing the authentication configuration."

Using this method will clear the server value when the bean is PUT to the server. Use the clearPassword() method to avoid clearing the server's value.

See the description of Null values.

See Also:

PASSWORD

getUserName

public String getUserName()

Get the value for the 'user' field. The description of the 'user' field is:

"The name of the user account that is to be used in testing the authentication configuration."

Returns:

The field's value in the bean instance, if any (may return null).

See Also:

USERNAME

isUserNameNull

public boolean isUserNameNull()

Get whether the 'user' field has been set to Null or not. The description of the 'user' field is:

"The name of the user account that is to be used in testing the authentication configuration."

See the description of Null values.

Returns:

true if the field value has been marked as null, false otherwise.

See Also:

setUserNameNull(), USERNAME

isUserNameClear

public boolean isUserNameClear()

Get whether the value for the 'user' field is clear or not. The description of the 'user' field is:

"The name of the user account that is to be used in testing the authentication configuration."

See the description of cleared values.

Returns:

true if the field value has been cleared, false otherwise.

See Also:

clearUserName(), USERNAME

setUserName

public void setUserName(String userName)

Set the value for the 'user' field. The description of the 'user' field is:

"The name of the user account that is to be used in testing the authentication configuration."

Parameters:

userName - Value to set

See Also:

USERNAME

clearUserName

public void clearUserName()

Clear any current value for the 'user' field in the bean. The description of the 'user' field is:

"The name of the user account that is to be used in testing the authentication configuration."

Using this method will not clear the server value when the bean is PUT to the server. Use the setUserNameNull() method to clear the server's value.

See the description of cleared values.

See Also:

USERNAME

setUserNameNull

public void setUserNameNull()

Set to Null any current value for the 'user' field in the bean. The description of the 'user' field is:

"The name of the user account that is to be used in testing the authentication configuration."

Using this method will clear the server value when the bean is PUT to the server. Use the clearUserName() method to avoid clearing the server's value.

See the description of Null values.

See Also:

USERNAME

getBeanMetaData

public static BeanMetaData<? extends AuthenticationTestBean> getBeanMetaData()

Get the metadata class instance for this type.

The metadata is used primarily as a parameter to a BeanTransporter implementation''s constructor.

clone

public AuthenticationTestBean clone()

Create a duplicate of this bean instance, including all field values.

Overrides:

clone in class Object