Skip navigation links

oracle.rules.sdk.store
Class Registration

java.lang.Object
oracle.rules.sdk.store.Registration

public class Registration

extends java.lang.Object

This class is used to register an implementation of the RepositoryConnection with the RepositoryConnectionFactory.

Field Summary

static java.lang.String	DESCRIPTION The suffix for the base key used to get the description.
static java.lang.String	NAME The suffix for the base key used to get the name.

Constructor Summary

Registration(java.lang.String key, java.lang.String className, java.lang.String resourceBundleName, java.lang.String descriptionKey, java.lang.String[] initPropertyKeys, java.lang.String[] requiredPropertyKeys)
Creates a new Registration.

Registration(java.lang.String key, java.lang.String className, java.lang.String resourceBundleName, java.lang.String descriptionKey, java.lang.String[] initPropertyKeys, java.lang.String[] requiredPropertyKeys, java.lang.String[] sensitivePropertyKeys)
Creates a new Registration.

Method Summary

java.lang.String	getClassName() Returns the className of the RepositoryConnection for this implementation.
java.lang.String	getDescriptionKey() Returns the base key for the name and description for the RepositoryConnection implementation this registration represents.
java.lang.String[]	getInitPropertyKeys() Returns an array of base keys, one per initialization parameter.
java.lang.String	getKey() Returns The key used to register this registration.
java.lang.String	getResourceBundleName() Returns the class name of the ResourceBundle for this implementation.
boolean	isRequiredInitProperty(java.lang.String key) Returns true if the initialization property associated with the base key, key is required.
boolean	isSensitiveInitProperty(java.lang.String key) Returns true if the value initialization property associated with the base key, key should not be displayed when entered as the value is sensitive.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

NAME

public static final java.lang.String NAME

The suffix for the base key used to get the name.

See Also:

Constant Field Values

DESCRIPTION

public static final java.lang.String DESCRIPTION

The suffix for the base key used to get the description.

See Also:

Constant Field Values

Constructor Detail

Registration

public Registration(java.lang.String key,
                    java.lang.String className,
                    java.lang.String resourceBundleName,
                    java.lang.String descriptionKey,
                    java.lang.String[] initPropertyKeys,
                    java.lang.String[] requiredPropertyKeys)

Creates a new Registration. The key for this registration should be documented publically.

Parameters:

key - the key used to look up this registration

className - the name of the class that implements RepositoryConnection

resourceBundleName - the class name of the ResourceBundle that contains the messages corresponding to the keys passed in the next two parameters.

descriptionKey - the base key for the name and description of this RepositoryConnection implementation

initPropertyKeys - the base keys for the name and description of each initialization property for this RepositoryConnection implementation. The base key is appended with the NAME and DESCRIPTION suffixes to retrieve the name and description, respectively, from the resource bundle. These keys must be the same keys used to store the properties passed to the getRepositoryConnection method in RepositoryConnectionFactory.

requiredPropertyKeys - the subset of the initPropertyKeys keys that are for the required initialization properties.

Registration

public Registration(java.lang.String key,
                    java.lang.String className,
                    java.lang.String resourceBundleName,
                    java.lang.String descriptionKey,
                    java.lang.String[] initPropertyKeys,
                    java.lang.String[] requiredPropertyKeys,
                    java.lang.String[] sensitivePropertyKeys)

Creates a new Registration. The key for this registration should be documented publically.

Parameters:

key - the key used to look up this registration

className - the name of the class that implements RepositoryConnection

resourceBundleName - the class name of the ResourceBundle that contains the messages corresponding to the keys passed in the next two parameters.

descriptionKey - the base key for the name and description of this RepositoryConnection implementation

initPropertyKeys - the base keys for the name and description of each initialization property for this RepositoryConnection implementation. The base key is appended with the NAME and DESCRIPTION suffixes to retrieve the name and description, respectively, from the resource bundle. These keys must be the same keys used to store the properties passed to the getRepositoryConnection method in RepositoryConnectionFactory.

requiredPropertyKeys - the subset of the initPropertyKeys keys that are for the required initialization properties.

sensitivePropertyKeys - the subset of the initPropertyKeys keys whose corresponding values should not be displayed when entered as the value is sensitive.

Method Detail

getKey

public java.lang.String getKey()

Returns The key used to register this registration.

Returns:

The key used to register this registration.

getClassName

public java.lang.String getClassName()

Returns the className of the RepositoryConnection for this implementation.

Returns:

the className of the RepositoryConnection for this implementation.

getResourceBundleName

public java.lang.String getResourceBundleName()

Returns the class name of the ResourceBundle for this implementation.

Returns:

the class name of the ResourceBundle for this implementation.

getDescriptionKey

public java.lang.String getDescriptionKey()

Returns the base key for the name and description for the RepositoryConnection implementation this registration represents. This key is used in combination with the NAME and DESCRIPTION suffixes to get the name and description from the resource bundle.

Returns:

the base key for the name and description.

getInitPropertyKeys

public java.lang.String[] getInitPropertyKeys()

Returns an array of base keys, one per initialization parameter. These keys are used in combination with the NAME and DESCRIPTION suffixes to get the name and description from the resource bundle.

Returns:

an array of keys.

isRequiredInitProperty

public boolean isRequiredInitProperty(java.lang.String key)

Returns true if the initialization property associated with the base key, key is required.

Parameters:

key - the initialization property base key

Returns:

true if the property is required, else false.

isSensitiveInitProperty

public boolean isSensitiveInitProperty(java.lang.String key)

Returns true if the value initialization property associated with the base key, key should not be displayed when entered as the value is sensitive.

Parameters:

key - the initialization property base key

Returns:

true if the property is required, else false.

Skip navigation links