org.jboss.as.controller.security

Class CredentialReference

java.lang.Object

org.jboss.as.controller.security.CredentialReference

All Implemented Interfaces:

Destroyable

public final class CredentialReference
extends Object
implements Destroyable

Class unifying access to credentials defined through CredentialStore or holding simply char[] as a secret. It defines credential reference attribute that other subsystems can use to reference external credentials of various types.

Author:

Peter Skopek

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALIAS Definition of id used in model
static String	CLEAR_TEXT Definition of id used in model
static String	CREDENTIAL_REFERENCE Definition of id used in model
static String	STORE Definition of id used in model
static String	TYPE Definition of id used in model

Method Summary

Modifier and Type	Method and Description
static CredentialReference	createCredentialReference(char[] secret) Method to create new CredentialReference based on secret attribute only.
static CredentialReference	createCredentialReference(String credentialStoreName, String alias, String credentialType) Method to create new CredentialReference based on params
static String	credentialReferencePartAsStringIfDefined(OperationContext context, ObjectTypeAttributeDefinition attributeDefinition, org.jboss.dmr.ModelNode model, String name) Utility method to return part of ObjectTypeAttributeDefinition for credential reference attribute.
void	destroy() Destroy the secret stored in this Object.
String	getAlias() Get the credential alias which denotes credential stored inside named credential store.
static ObjectTypeAttributeDefinition.Builder	getAttributeBuilder(String name, String xmlName, boolean allowNull) Get the attribute builder for credential-reference attribute with specified characteristics.
static ObjectTypeAttributeDefinition	getAttributeDefinition() Returns new definition for credential reference attribute.
String	getCredentialStoreName() Get the credential store name part of this reference.
String	getCredentialType() Get credential type which narrows selection of the credential stored under the alias in the credential store.
char[]	getSecret() Get the secret stored as clear text in this reference.
boolean	isDestroyed() Determine if this Object has been destroyed.
static void	reinjectCredentialStoreClient(org.jboss.msc.value.InjectedValue<CredentialStoreClient> injectedCredentialStoreClient, CredentialReference credentialReference) Replace injection with new one referencing the same CredentialStore but based of new values of CredentialReference

Methods inherited from class java.lang.Object

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

Field Detail

CREDENTIAL_REFERENCE

public static final String CREDENTIAL_REFERENCE

Definition of id used in model

See Also:

Constant Field Values

STORE

public static final String STORE

Definition of id used in model

See Also:

Constant Field Values

ALIAS

public static final String ALIAS

Definition of id used in model

See Also:

Constant Field Values

TYPE

public static final String TYPE

Definition of id used in model

See Also:

Constant Field Values

CLEAR_TEXT

public static final String CLEAR_TEXT

Definition of id used in model

See Also:

Constant Field Values

Method Detail

getCredentialStoreName

public String getCredentialStoreName()

Get the credential store name part of this reference.

Returns:

credential store name or null

getAlias

public String getAlias()

Get the credential alias which denotes credential stored inside named credential store.

Returns:

alias of the referenced credential or null

getCredentialType

public String getCredentialType()

Get credential type which narrows selection of the credential stored under the alias in the credential store.

Returns:

credential type (class name of desired credential type) or null

getSecret

public char[] getSecret()

Get the secret stored as clear text in this reference.

Returns:

secret value as clear text or null

destroy

public void destroy()

Destroy the secret stored in this Object.

Specified by:

destroy in interface Destroyable

isDestroyed

public boolean isDestroyed()

Determine if this Object has been destroyed.

Specified by:

isDestroyed in interface Destroyable

Returns:

true if this Object has been destroyed, false otherwise.

createCredentialReference

public static CredentialReference createCredentialReference(char[] secret)

Method to create new CredentialReference based on secret attribute only.

Parameters:

secret - to reference

Returns:

new CredentialReference

createCredentialReference

public static CredentialReference createCredentialReference(String credentialStoreName,
                                                            String alias,
                                                            String credentialType)

Method to create new CredentialReference based on params

Parameters:

credentialStoreName - credential store name

alias - denoting the credential

credentialType - type of credential (can be null)

Returns:

new CredentialReference

getAttributeDefinition

public static ObjectTypeAttributeDefinition getAttributeDefinition()

Returns new definition for credential reference attribute.

Returns:

credential reference attribute definition

getAttributeBuilder

public static ObjectTypeAttributeDefinition.Builder getAttributeBuilder(String name,
                                                                        String xmlName,
                                                                        boolean allowNull)

Get the attribute builder for credential-reference attribute with specified characteristics.

Parameters:

name - name of attribute

xmlName - name of xml element

allowNull - whether the attribute is required

Returns:

new ObjectTypeAttributeDefinition.Builder which can be used to build attribute definition

credentialReferencePartAsStringIfDefined

public static String credentialReferencePartAsStringIfDefined(OperationContext context,
                                                              ObjectTypeAttributeDefinition attributeDefinition,
                                                              org.jboss.dmr.ModelNode model,
                                                              String name)
                                                       throws OperationFailedException

Utility method to return part of ObjectTypeAttributeDefinition for credential reference attribute. getAttributeDefinition()

Parameters:

context - operational context

attributeDefinition - attribute definition

model - model

name - name of part to return (supported names: STORE ALIAS TYPE CLEAR_TEXT

Returns:

value of part as String

Throws:

OperationFailedException - when something goes wrong

reinjectCredentialStoreClient

public static void reinjectCredentialStoreClient(org.jboss.msc.value.InjectedValue<CredentialStoreClient> injectedCredentialStoreClient,
                                                 CredentialReference credentialReference)
                                          throws ClassNotFoundException

Replace injection with new one referencing the same CredentialStore but based of new values of CredentialReference

Parameters:

injectedCredentialStoreClient - InjectedValue to replace the credential reference

credentialReference - new credential reference

Throws:

ClassNotFoundException - when credential reference holding credential type which cannot be resolved using current providers