com.webmethods.caf.wsclient.saml

Interface IArtifactFactory

public interface IArtifactFactory

This encapsulates the access logic required to obtain a new SAML Artifact from the SAML security provider. The artifact represents a timebound, once-only-verifiable user token provided by the SAML security provider. The logic should make sure to obtain a new value each time the getArtifact() method is invoked. For example, webMethods Portal provides a PortalArtifactFactory implementation of this interface to manage artifacts within Portal

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME_ID
static int	SAML_VERSION_1_1
static int	SAML_VERSION_2_0

Method Summary

Modifier and Type	Method and Description
String	getArtifact() Retrieve an artifact String from the ArtifactFactory
String	getAssertion() Generate an assertion using SIN service.
String	getAssertion(int samlVersion)
String	getAssertion(String user)
String	getAssertion(String user, int samlVersion)
String	getAssertion(String user, int samlVersion, boolean encode)
String	getAssertion(String user, String[] groups, Map<String,String> roles)
String	getAssertion(String user, String[] groups, Map<String,String> roles, Map<String,String> attributes)
String	getAssociatedUser() Obtain the user name associated with the SAML artifact (usually the current user)
String	validateAssertion(String assertion) Validate a SAML assertion and returns the associated user id.
Map<String,String>	validateSAMLResponse(HttpServletRequest request, String samlRespParamName) Validate a SAML response and returns assertion attributes and its values in the authentication data object.

Field Detail

SAML_VERSION_1_1

static final int SAML_VERSION_1_1

See Also:

Constant Field Values

SAML_VERSION_2_0

static final int SAML_VERSION_2_0

See Also:

Constant Field Values

NAME_ID

static final String NAME_ID

See Also:

Constant Field Values

Method Detail

getArtifact

String getArtifact()

Retrieve an artifact String from the ArtifactFactory

Returns:

String the SAML artifact.

getAssertion

String getAssertion()

Generate an assertion using SIN service.

Returns:

String the SAML artifact.

getAssertion

String getAssertion(int samlVersion)

getAssertion

String getAssertion(String user)

getAssertion

String getAssertion(String user,
                    int samlVersion)

getAssertion

String getAssertion(String user,
                    int samlVersion,
                    boolean encode)

getAssertion

String getAssertion(String user,
                    String[] groups,
                    Map<String,String> roles)

getAssertion

String getAssertion(String user,
                    String[] groups,
                    Map<String,String> roles,
                    Map<String,String> attributes)

validateAssertion

String validateAssertion(String assertion)

Validate a SAML assertion and returns the associated user id.

Parameters:

assertion - a SAML1.1/SAML2 assertion.

Returns:

user id

validateSAMLResponse

Map<String,String> validateSAMLResponse(HttpServletRequest request,
                                        String samlRespParamName)

Validate a SAML response and returns assertion attributes and its values in the authentication data object.

Parameters:

{@link - HttpServletRequest} request

Returns:

Map for each value under a named Attribute in an Assertion from the SAML Response

getAssociatedUser

String getAssociatedUser()

Obtain the user name associated with the SAML artifact (usually the current user)

Returns:

String the associated user name as String