SiteMinder
Java SDK r12.51


com.netegrity.policyserver.smapi
Class FedNIDContext

java.lang.Object
  extended by com.netegrity.policyserver.smapi.FedNIDContext

public class FedNIDContext
extends java.lang.Object

The FedNIDContext class facilitates manipulation of Name Identifiers through the Name Identifier API (NID API). It accesses the NID API thought Java Factory.


Constructor Summary
FedNIDContext(ActiveExpressionContext ctxt)
          Construct a FedNIDContext class instance.
FedNIDContext(java.lang.String userId)
          Construct a FedNIDContext class instance.
 
Method Summary
 java.lang.String Federate(java.lang.String nid, java.lang.String providerId)
          Federates the current Principal using the specified name identifier.
 java.lang.String GenerateOpaqueName(java.lang.String providerId)
          Generates an opaque name.
 java.lang.String LookupFederationIDP(java.lang.String providerId)
          Returns an existing Name Identifier for the Principal that was generated by the Identity Provider.
 java.lang.String LookupFederationSP(java.lang.String providerId)
          Returns an existing Name Identifier for the Principal that was generated by the Service Provider.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FedNIDContext

public FedNIDContext(java.lang.String userId)
Construct a FedNIDContext class instance. Note that this constructor is for testing purposes only.

Parameters:
userId - An ID of the user.

FedNIDContext

public FedNIDContext(ActiveExpressionContext ctxt)
Construct a FedNIDContext class instance.

Parameters:
ctxt - A reference to the ActiveExpressionContext class.
Method Detail

LookupFederationIDP

public java.lang.String LookupFederationIDP(java.lang.String providerId)
Returns an existing Name Identifier for the Principal that was generated by the Identity Provider. The current Principal defined in the User Context as part of the Active Expression Context passed in the constructor. The method returns null if no Name Identifier is found for the Principal.

Parameters:
providerId - An ID of a Service or Identity Provider that is requesting an Authentication Assertion.
Returns:
Name Identifier if federation exists for the user. Returns null otherwise.

LookupFederationSP

public java.lang.String LookupFederationSP(java.lang.String providerId)
Returns an existing Name Identifier for the Principal that was generated by the Service Provider. The current Principal defined in the User Context as part of the Active Expression Context passed in the constructor. The method returns null if no Name Identifier is found for the Principal.

Parameters:
providerId - An ID of a Service or Identity Provider that is requesting an Authentication Assertion.
Returns:
Name Identifier if federation exists for the user. Returns null otherwise.

GenerateOpaqueName

public java.lang.String GenerateOpaqueName(java.lang.String providerId)
Generates an opaque name.

Parameters:
providerId - An ID of a Service or Identity Provider that is requesting an Authentication Assertion.
Returns:
An opaque name or null on error.

Federate

public java.lang.String Federate(java.lang.String nid,
                                 java.lang.String providerId)
Federates the current Principal using the specified name identifier.

Parameters:
nid - The function federates the current Principal using provided name identifier. The function will call the corresponding JNI method passing the name identifier, provider name, and the user context as parameters. Note that the function will replace the existing Name Identifier if one is present.
providerId - An ID of a Service or Identity Provider that is requesting an Authentication Assertion.
Returns:
If the Principal is successfully federated, the method returns the Principal’s name identifier. The function returns null otherwise.

SiteMinder
Java SDK r12.51

Mon 04/08/2013

http://ca.com
Copyright (c) 2013 CA.