org.jboss.as.controller.security

Class CredentialStoreURIParser

java.lang.Object

org.jboss.as.controller.security.CredentialStoreURIParser

public class CredentialStoreURIParser
extends Object

This class provides parsing for URIs with scheme "cr-store".

Credential Store URI is used for configuring/referencing credential stores. It can specify complete information about credential store including parameters as well as reference of stored secured credentials (such as passwords).

Credential Store URI scheme

crStoreURI = scheme : //store_name [/ storage_file] [?query] [# attribute_name] scheme = cr-store store_name = // alpha *alphanum storage_file = file_name_uri query = store_parameter = value *[; store_parameter = value] store_parameter = alpha *alphanum value = 'alpha *alphanum' | alpha *alphanum attribute_name = alpha *alphanum

Credential Store URI has to be absolute with store_name> always defined.

parameters to {@link org.wildfly.security.credential.store.CredentialStoreSpi} implementation are supplied through query part of URI. In case they need to decode binary value Base64 encoding method should be used.

Author:

Peter Skopek.

Field Summary

Fields

Modifier and Type	Field and Description
static String	CR_STORE_SCHEME Credential Store URI scheme name ("cr-store").

Constructor Summary

Constructors

Constructor and Description
CredentialStoreURIParser(String uri) Creates CredentialStoreURIParser based on given URI
CredentialStoreURIParser(URI uri) Creates CredentialStoreURIParser based on given URI

Method Summary

Modifier and Type	Method and Description
String	getAttribute() Returns attribute specified by parsed Credential Store URI
String	getName() Returns parsed credential store name.
Map<String,String>	getOptionsMap() Returns new Map<String, Object> for use in {@link org.wildfly.security.credential.store.CredentialStoreSpi} to initialize it.
String	getParameter(String param) Fetch parameter value from query string.
Set<String>	getParameters() Returns Set<String> of parameters specified by the parsed Credential Store URI.
String	getScheme() Returns scheme handled by this parser.
String	getStorageFile() If storage file was not specified by the Credential Store URI returns null
static String	safeCRStoreURI(String uri) Transforms given parameter to safely displayed String by stripping potentially sensitive information from the URI.

Methods inherited from class java.lang.Object

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

Field Detail

CR_STORE_SCHEME

public static final String CR_STORE_SCHEME

Credential Store URI scheme name ("cr-store").

See Also:

Constant Field Values

Constructor Detail

CredentialStoreURIParser

public CredentialStoreURIParser(String uri)
                         throws URISyntaxException

Creates CredentialStoreURIParser based on given URI

Parameters:

uri - URI to parse

Throws:

URISyntaxException - in case of problems parsing given URI

CredentialStoreURIParser

public CredentialStoreURIParser(URI uri)

Creates CredentialStoreURIParser based on given URI

Parameters:

uri - URI to parse

Method Detail

getName

public String getName()

Returns parsed credential store name.

Returns:

credential store name

getScheme

public String getScheme()

Returns scheme handled by this parser.

Returns:

Credential Store URI scheme (always CR_STORE_SCHEME)

safeCRStoreURI

public static String safeCRStoreURI(String uri)

Transforms given parameter to safely displayed String by stripping potentially sensitive information from the URI.

Parameters:

uri - original URI string

Returns:

String safe to display

getStorageFile

public String getStorageFile()

If storage file was not specified by the Credential Store URI returns null

Returns:

storage file as parsed from Credential Store URI as String

getAttribute

public String getAttribute()

Returns attribute specified by parsed Credential Store URI

Returns:

attribute from Credential Store URI, if attribute was not specified then null

getParameter

public String getParameter(String param)

Fetch parameter value from query string.

Parameters:

param - name of wanted parameter

Returns:

parameter value as a String or null if parameter was not specified in query part of the URI

getParameters

public Set<String> getParameters()

Returns Set<String> of parameters specified by the parsed Credential Store URI.

Returns:

set of parameter names

getOptionsMap

public Map<String,String> getOptionsMap()

Returns new Map<String, Object> for use in {@link org.wildfly.security.credential.store.CredentialStoreSpi} to initialize it.

Returns:

Map of options parsed from the Credential Store URI