org.n52.security.authentication
Class CredentialFactory

java.lang.Object
  extended by org.n52.security.authentication.CredentialFactory

public class CredentialFactory
extends java.lang.Object

A CredentialFactory is used to relate authentication method urns to credential converters, which create Credentail instances from plain strings.

You can use the static "default factory" approach or manage your own mappings. To add special credential-urn mappings, simple add apropriate converters to the factory.

Author:
Arne Broering, Marko Reiprecht

Nested Class Summary
static interface CredentialFactory.CredentialConverter
          A CredentialConverter is responsible to convert a plain string in a concrete credential instance and vise versa.
static class CredentialFactory.SAMLCredentialConverter
          Class SAMLCredentialConverter.
static class CredentialFactory.SessionIDCredentialConverter
          Class SessionIDCredentialConverter.
static class CredentialFactory.UsernamePasswordCredentialConverter
          Class Base64UsernamePasswordCredentialConverter.
 
Constructor Summary
CredentialFactory()
          Constructor creates a new instance.
 
Method Summary
 CredentialFactory add(java.lang.String authenticationMethodUrn, CredentialFactory.CredentialConverter converter)
          Method add.
 CredentialFactory clear()
          Method clear.
 Credential create(AuthenticationMethod pMethod, java.lang.String encodedCredential)
          Method createCredential.
 Credential create(java.lang.String authenticationMethodUrn, java.lang.String encodedCredential)
          Method createCredential.
 java.lang.String encode(AuthenticationMethod pMethod, Credential credential)
          Method createCredential.
 java.lang.String encode(java.lang.String authenticationMethodUrn, Credential credential)
          Method createCredential.
 CredentialFactory.CredentialConverter get(java.lang.String authenticationMethodUrn)
          Method get.
static CredentialFactory getDefaultFactory()
          Method gets the defaultFactory.
 CredentialFactory remove(java.lang.String authenticationMethodUrn)
          Method remove.
static void setDefaultFactory(CredentialFactory defaultFactoryParam)
          Method sets the defaultFactory.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CredentialFactory

public CredentialFactory()
Constructor creates a new instance. The factory will contain the same settings like the original default factory.

Method Detail

add

public CredentialFactory add(java.lang.String authenticationMethodUrn,
                             CredentialFactory.CredentialConverter converter)
Method add.

Parameters:
authenticationMethodUrn - the authenticationMethodUrn.
converter - the converter.
Returns:
CredentialFactory.

getDefaultFactory

public static CredentialFactory getDefaultFactory()
Method gets the defaultFactory.

Returns:
CredentialFactory.

setDefaultFactory

public static void setDefaultFactory(CredentialFactory defaultFactoryParam)
Method sets the defaultFactory.

Parameters:
defaultFactory - the defaultFactory.

clear

public CredentialFactory clear()
Method clear.

Returns:
CredentialFactory.

create

public Credential create(AuthenticationMethod pMethod,
                         java.lang.String encodedCredential)
Method createCredential.

Parameters:
pMethod - the pMethod.
encodedCredential - the encodedCredential.
Returns:
Credential.

create

public Credential create(java.lang.String authenticationMethodUrn,
                         java.lang.String encodedCredential)
Method createCredential.

Parameters:
authenticationMethodUrn - the authenticationMethodUrn.
encodedCredential - the encodedCredential.
Returns:
Credential
Throws:
java.lang.IllegalStateException - if an authentication method was specified for which no credential converter was registered

encode

public java.lang.String encode(AuthenticationMethod pMethod,
                               Credential credential)
Method createCredential.

Parameters:
pMethod - the pMethod.
credential - the encodedCredential.
Returns:
Credential.

encode

public java.lang.String encode(java.lang.String authenticationMethodUrn,
                               Credential credential)
Method createCredential.

Parameters:
authenticationMethodUrn - the authenticationMethodUrn.
credential - the encodedCredential.
Returns:
Credential.

get

public CredentialFactory.CredentialConverter get(java.lang.String authenticationMethodUrn)
Method get.

Parameters:
authenticationMethodUrn - the authenticationMethodUrn.
Returns:
CredentialConverter.

remove

public CredentialFactory remove(java.lang.String authenticationMethodUrn)
Method remove.

Parameters:
authenticationMethodUrn - the authenticationMethodUrn.
Returns:
CredentialFactory.


Copyright © 2004-2009 52north.org. All Rights Reserved.