org.jboss.as.controller.security

Class CredentialReference

java.lang.Object

org.jboss.as.controller.security.CredentialReference

public final class CredentialReference
extends Object

Utility class holding attribute definitions for credential-reference attribute in the model. The class is unifying access to credentials defined through CredentialStore. 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	CREDENTIAL_STORE_CAPABILITY Required capability by credential-reference
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 String	credentialReferencePartAsStringIfDefined(org.jboss.dmr.ModelNode credentialReferenceValue, String name) Utility method to return part of ObjectTypeAttributeDefinition for credential reference attribute.
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.
static org.wildfly.common.function.ExceptionSupplier<org.wildfly.security.credential.source.CredentialSource,Exception>	getCredentialSourceSupplier(OperationContext context, ObjectTypeAttributeDefinition credentialReferenceAttributeDefinition, org.jboss.dmr.ModelNode model, org.jboss.msc.service.ServiceBuilder<?> serviceBuilder) Get the ExceptionSupplier of CredentialSource which might throw an Exception while getting it.

Methods inherited from class java.lang.Object

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

Field Detail

CREDENTIAL_STORE_CAPABILITY

public static final String CREDENTIAL_STORE_CAPABILITY

Required capability by credential-reference

See Also:

Constant Field Values

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

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(org.jboss.dmr.ModelNode credentialReferenceValue,
                                                              String name)
                                                       throws OperationFailedException

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

Parameters:

credentialReferenceValue - value of credential reference attribute

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

getCredentialSourceSupplier

public static org.wildfly.common.function.ExceptionSupplier<org.wildfly.security.credential.source.CredentialSource,Exception> getCredentialSourceSupplier(OperationContext context,
                                                                                                                                                           ObjectTypeAttributeDefinition credentialReferenceAttributeDefinition,
                                                                                                                                                           org.jboss.dmr.ModelNode model,
                                                                                                                                                           org.jboss.msc.service.ServiceBuilder<?> serviceBuilder)
                                                                                                                                                    throws OperationFailedException

Get the ExceptionSupplier of CredentialSource which might throw an Exception while getting it. CredentialSource is used later to retrieve the credential requested by configuration.

Parameters:

context - operation context

credentialReferenceAttributeDefinition - credential-reference attribute definition

model - containing the actual values

serviceBuilder - of service which needs the credential

Returns:

ExceptionSupplier of CredentialSource

Throws:

OperationFailedException - wrapping exception when something goes wrong