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


Method Summary
 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 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.
 

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)

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

getAssociatedUser

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

Returns:
String the associated user name as String