org.apache.ws.security.saml
Class SAMLIssuerFactory

java.lang.Object
  extended by org.apache.ws.security.saml.SAMLIssuerFactory

public abstract class SAMLIssuerFactory
extends Object

CryptoFactory.

Author:
Davanum Srinivas (dims@yahoo.com).

Constructor Summary
SAMLIssuerFactory()
           
 
Method Summary
static SAMLIssuer getInstance()
          getInstance

Returns an instance of SAMLIssuer.

static SAMLIssuer getInstance(Class<? extends SAMLIssuer> samlClass, Properties properties)
          getInstance

Returns an instance of SAMLIssuer.

static SAMLIssuer getInstance(String propFilename)
          getInstance

Returns an instance of SAMLIssuer.

 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

SAMLIssuerFactory

public SAMLIssuerFactory()
Method Detail

getInstance

public static SAMLIssuer getInstance()
                              throws WSSecurityException
getInstance

Returns an instance of SAMLIssuer. This method uses the file saml.properties to determine which implementation to use. Thus the property org.apache.ws.security.saml.issuerClass must define the classname of the SAMLIssuer implementation. The file may contain other property definitions as well. These properties are handed over to the SAMLIssuer implementation. The file saml.properties is loaded with the Loader.getResource() method.

Returns:
The SAMLIssuer implementation was defined
Throws:
WSSecurityException - if there is an error in loading the crypto properties

getInstance

public static SAMLIssuer getInstance(Class<? extends SAMLIssuer> samlClass,
                                     Properties properties)
                              throws WSSecurityException
getInstance

Returns an instance of SAMLIssuer. The properties are handed over the the SAMLIssuer implementation. The properties can be null. It is dependent on the SAMLIssuer implementation how the initialization is done in this case.

Parameters:
samlClass - This is the SAMLIssuer implementation class. No default is provided here.
properties - The Properties that are forwarded to the SAMLIssuer implementation. These properties are dependent on the SAMLIssuer implementation
Returns:
The SAMLIssuer implementation or null if no samlClassName was defined
Throws:
WSSecurityException - if there is an error in loading the crypto properties

getInstance

public static SAMLIssuer getInstance(String propFilename)
                              throws WSSecurityException
getInstance

Returns an instance of SAMLIssuer. This method uses the specified filename to load a property file. This file shall use the property org.apache.ws.security.saml.issuerClass to define the classname of the SAMLIssuer implementation. The file may contain other property definitions as well. These properties are handed over to the SAMLIssuer implementation. The specified file is loaded with the Loader.getResource() method.

Parameters:
propFilename - The name of the property file to load
Returns:
The SAMLIssuer implementation that was defined
Throws:
WSSecurityException - if there is an error in loading the crypto properties


Copyright © 2004-2013 The Apache Software Foundation. All Rights Reserved.