com.novell.db.object.bean
Class AuthenticationConfigBean

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

public class AuthenticationConfigBean
extends SentinelBean

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

The description of the type is:

"An AuthenticationConfig object contains information about an authentication source and its configuration. An authentication source is used by Sentinel to validate a user's credentials when the user logs into 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

Nested Class Summary

static class

AuthenticationConfigBean.TypeType An enumerated type representing values for the field 'type'.

Field Summary

static String	PROPERTIES The "bean name" of the Sentinel data object field 'Properties'.
static String	SERVERCERTIFICATE The "bean name" of the Sentinel data object field 'ServerCertificate'.
static String	TEST The "bean name" of the Sentinel data object field 'Test'.
static String	TYPE The "bean name" of the Sentinel data object field 'Type'.

Constructor Summary

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

Method Summary

void	addToProperties(String keyValue, String valueValue) Add a value to the collection field 'properties'.
void	clearProperties() Clear any current value for the 'properties' field in the bean.
void	clearServerCertificateLink() Clear any current URL value for the 'cert' field in the bean.
void	clearTest() Clear any current value for the 'test' field in the bean.
void	clearType() Clear any current value for the 'type' field in the bean.
AuthenticationConfigBean	clone() Create a duplicate of this bean instance, including all field values.
static BeanMetaData<? extends AuthenticationConfigBean>	getBeanMetaData() Get the metadata class instance for this type.
Map<String,String>	getProperties() Get the value for the 'properties' field.
String	getServerCertificateLink() Get the URL for the 'cert' field.
AuthenticationConfigBean.TypeType	getType() Get the value for the 'type' field.
boolean	isPropertiesClear() Get whether the value for the 'properties' field is clear or not.
boolean	isPropertiesNull() Get whether the 'properties' field has been set to Null or not.
boolean	isServerCertificateLinkClear() Get whether the value for the 'cert' URL field is clear or not.
boolean	isServerCertificateLinkNull() Get whether the 'cert' URL field has been set to Null or not.
boolean	isTest() Get the value for the 'test' field.
boolean	isTestClear() Get whether the value for the 'test' field is clear or not.
boolean	isTestNull() Get whether the 'test' field has been set to Null or not.
boolean	isTypeClear() Get whether the value for the 'type' field is clear or not.
boolean	isTypeNull() Get whether the 'type' field has been set to Null or not.
void	setProperties(Map<? extends String,? extends String> properties) Set the value for the 'properties' field.
void	setPropertiesNull() Set to Null any current value for the 'properties' field in the bean.
void	setServerCertificateLink(String serverCertificate) Set a URL value for the 'cert' field.
void	setServerCertificateLinkNull() Set to Null any current URL value for the 'cert' field in the bean.
void	setTest(boolean test) Set the value for the 'test' field.
void	setTestNull() Set to Null any current value for the 'test' field in the bean.
void	setType(AuthenticationConfigBean.TypeType type) Set the value for the 'type' field.
void	setTypeNull() Set to Null any current value for the 'type' 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

TEST

public static final String TEST

The "bean name" of the Sentinel data object field 'Test'. The value is ""test"".

The description of the 'test' field is:

"True if the AuthenticationConfig object exists for the purpose of testing."

See Also:

Constant Field Values

SERVERCERTIFICATE

public static final String SERVERCERTIFICATE

The "bean name" of the Sentinel data object field 'ServerCertificate'. The value is ""cert"".

The description of the 'cert' field is:

"The URL of the server certificate for TLS-protected LDAP authentication, if any."

See Also:

Constant Field Values

PROPERTIES

public static final String PROPERTIES

The "bean name" of the Sentinel data object field 'Properties'. The value is ""properties"".

The description of the 'properties' field is:

"A collection of name-value pairs that are specific to the authentication configuration type."

See Also:

Constant Field Values

TYPE

public static final String TYPE

The "bean name" of the Sentinel data object field 'Type'. The value is ""type"".

The description of the 'type' field is:

"The type of authentication configuration. Currently two types are supported: "DATABASE", and "LDAP". "DATABASE" implies that user credentials are authenticated against the internal Sentinel database. "LDAP" implies that user credentials are authenticated against an external LDAP directory."

See Also:

Constant Field Values

Constructor Detail

AuthenticationConfigBean

public AuthenticationConfigBean()

Construct an instance of the bean class.

AuthenticationConfigBean

protected AuthenticationConfigBean(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

getServerCertificateLink

public String getServerCertificateLink()

Get the URL for the 'cert' field. The description of the 'cert' field is:

"The URL of the server certificate for TLS-protected LDAP authentication, if any."

Returns:

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

See Also:

SERVERCERTIFICATE

isServerCertificateLinkNull

public boolean isServerCertificateLinkNull()

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

"The URL of the server certificate for TLS-protected LDAP authentication, if any."

See the description of Null values.

Returns:

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

See Also:

setServerCertificateLinkNull(), SERVERCERTIFICATE

isServerCertificateLinkClear

public boolean isServerCertificateLinkClear()

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

"The URL of the server certificate for TLS-protected LDAP authentication, if any."

See the description of cleared values.

Returns:

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

See Also:

clearServerCertificateLink(), SERVERCERTIFICATE

setServerCertificateLink

public void setServerCertificateLink(String serverCertificate)

Set a URL value for the 'cert' field. The description of the 'cert' field is:

"The URL of the server certificate for TLS-protected LDAP authentication, if any."

Parameters:

serverCertificate - Value to set

See Also:

SERVERCERTIFICATE

clearServerCertificateLink

public void clearServerCertificateLink()

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

"The URL of the server certificate for TLS-protected LDAP authentication, if any."

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

See the description of cleared values.

See Also:

SERVERCERTIFICATE

setServerCertificateLinkNull

public void setServerCertificateLinkNull()

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

"The URL of the server certificate for TLS-protected LDAP authentication, if any."

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

See the description of Null values.

See Also:

SERVERCERTIFICATE

isTest

public boolean isTest()

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

"True if the AuthenticationConfig object exists for the purpose of testing."

Returns:

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

See Also:

TEST

isTestNull

public boolean isTestNull()

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

"True if the AuthenticationConfig object exists for the purpose of testing."

See the description of Null values.

Returns:

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

See Also:

setTestNull(), TEST

isTestClear

public boolean isTestClear()

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

"True if the AuthenticationConfig object exists for the purpose of testing."

See the description of cleared values.

Returns:

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

See Also:

clearTest(), TEST

setTest

public void setTest(boolean test)

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

"True if the AuthenticationConfig object exists for the purpose of testing."

Parameters:

test - Value to set

See Also:

TEST

clearTest

public void clearTest()

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

"True if the AuthenticationConfig object exists for the purpose of testing."

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

See the description of cleared values.

See Also:

TEST

setTestNull

public void setTestNull()

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

"True if the AuthenticationConfig object exists for the purpose of testing."

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

See the description of Null values.

See Also:

TEST

getProperties

public Map<String,String> getProperties()

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

"A collection of name-value pairs that are specific to the authentication configuration type."

Returns:

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

See Also:

PROPERTIES

isPropertiesNull

public boolean isPropertiesNull()

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

"A collection of name-value pairs that are specific to the authentication configuration type."

See the description of Null values.

Returns:

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

See Also:

setPropertiesNull(), PROPERTIES

isPropertiesClear

public boolean isPropertiesClear()

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

"A collection of name-value pairs that are specific to the authentication configuration type."

See the description of cleared values.

Returns:

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

See Also:

clearProperties(), PROPERTIES

setProperties

public void setProperties(Map<? extends String,? extends String> properties)

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

"A collection of name-value pairs that are specific to the authentication configuration type."

Parameters:

properties - Value to set

See Also:

PROPERTIES

clearProperties

public void clearProperties()

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

"A collection of name-value pairs that are specific to the authentication configuration type."

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

See the description of cleared values.

See Also:

PROPERTIES

setPropertiesNull

public void setPropertiesNull()

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

"A collection of name-value pairs that are specific to the authentication configuration type."

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

See the description of Null values.

See Also:

PROPERTIES

addToProperties

public void addToProperties(String keyValue,
                            String valueValue)

Add a value to the collection field 'properties'. The description of the 'properties' field is:

"A collection of name-value pairs that are specific to the authentication configuration type."

Parameters:

keyValue - Value of key.

valueValue - Value to add to map.

See Also:

PROPERTIES

getType

public AuthenticationConfigBean.TypeType getType()

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

"The type of authentication configuration. Currently two types are supported: "DATABASE", and "LDAP". "DATABASE" implies that user credentials are authenticated against the internal Sentinel database. "LDAP" implies that user credentials are authenticated against an external LDAP directory."

Returns:

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

See Also:

TYPE

isTypeNull

public boolean isTypeNull()

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

"The type of authentication configuration. Currently two types are supported: "DATABASE", and "LDAP". "DATABASE" implies that user credentials are authenticated against the internal Sentinel database. "LDAP" implies that user credentials are authenticated against an external LDAP directory."

See the description of Null values.

Returns:

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

See Also:

setTypeNull(), TYPE

isTypeClear

public boolean isTypeClear()

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

"The type of authentication configuration. Currently two types are supported: "DATABASE", and "LDAP". "DATABASE" implies that user credentials are authenticated against the internal Sentinel database. "LDAP" implies that user credentials are authenticated against an external LDAP directory."

See the description of cleared values.

Returns:

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

See Also:

clearType(), TYPE

setType

public void setType(AuthenticationConfigBean.TypeType type)

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

"The type of authentication configuration. Currently two types are supported: "DATABASE", and "LDAP". "DATABASE" implies that user credentials are authenticated against the internal Sentinel database. "LDAP" implies that user credentials are authenticated against an external LDAP directory."

Parameters:

type - Value to set

See Also:

TYPE

clearType

public void clearType()

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

"The type of authentication configuration. Currently two types are supported: "DATABASE", and "LDAP". "DATABASE" implies that user credentials are authenticated against the internal Sentinel database. "LDAP" implies that user credentials are authenticated against an external LDAP directory."

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

See the description of cleared values.

See Also:

TYPE

setTypeNull

public void setTypeNull()

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

"The type of authentication configuration. Currently two types are supported: "DATABASE", and "LDAP". "DATABASE" implies that user credentials are authenticated against the internal Sentinel database. "LDAP" implies that user credentials are authenticated against an external LDAP directory."

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

See the description of Null values.

See Also:

TYPE

getBeanMetaData

public static BeanMetaData<? extends AuthenticationConfigBean> 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 AuthenticationConfigBean clone()

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

Overrides:

clone in class Object