Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle Access Management Mobile and Social


oracle.security.idaas.rp.client
Class RPClient

java.lang.Object
  extended by oracle.security.idaas.rp.client.RPClient


public class RPClient
extends java.lang.Object

This class is the main contract used by the application. It allows to get the list of the available IDP(s) and the reference URL of a selected IDP.

Since:
11g Release 2 (11.1.2)
Version:
11g Release 2 (11.1.2)

Constructor Summary
RPClient(java.lang.String applicationID, java.util.Properties config)
          This constructor builds for a given application ID the list of the available IDP name(s) to this application.

 

Method Summary
 java.util.Map<java.lang.String,java.lang.String> getAttrFromSaeToken(java.lang.String token, java.lang.String secret, java.lang.String encSecret)
          Return the Attributes Map from the given token.
 java.lang.String getHrefByIdpName(java.lang.String idpName)
          It returns the string of the URI necessary to use according to the given IDP name.
 java.util.List<java.lang.String> getIDPList()
          The call to this method returns a list of String that names all the available IDPs.
 java.lang.String getSaeToken(java.util.Map<java.lang.String,java.lang.String> hashmap, java.lang.String secret, java.lang.String encSecret)
          Return the sae token using the given elements.
 boolean isValidSaeToken(java.lang.String token, java.lang.String secret, java.lang.String encSecret)
          Return true when the given token is valid, and false in all other cases.

 

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

 

Constructor Detail

RPClient

public RPClient(java.lang.String applicationID,
                java.util.Properties config)
         throws RPClientException
This constructor builds for a given application ID the list of the available IDP name(s) to this application. The RPfC platform may use filters or policies to reduce the list of possible/available IDP(s) according to the application ID.

The configuration location argument locates where properties are defined to connect, to secure the exchanges between the RPfC platform and the RPClient, etc. It cannot be null.

The construction initiates the configuration service using the attribute named "rp.idp.service.url" from the <quot>SystemConfiguration<quot> section of the configuration.

Parameters:
applicationID - uniquely identifies the application asking for a list of IDP. It cannot be null and cannot be an empty String.
config - properties defined to connect, secure the exchanges between the RPfC platform and the RPClient, etc. It cannot be null.
Throws:
RPClientException - when an error occurred during the initialization.

Method Detail

getIDPList

public java.util.List<java.lang.String> getIDPList()
                                            throws RPClientException
The call to this method returns a list of String that names all the available IDPs. If the returned list is empty, then no IDP is available for this application. The returned list cannot be null.
Returns:
the list of IDP names
Throws:
RPCLientException - error occurs during this class initialization
RPClientException

getHrefByIdpName

public java.lang.String getHrefByIdpName(java.lang.String idpName)
It returns the string of the URI necessary to use according to the given IDP name. null is returned if the given name is not found or if the list of IDPs for this application is empty.
Parameters:
idpName - name of the select IDP
Returns:
null or the url to be used as href

isValidSaeToken

public boolean isValidSaeToken(java.lang.String token,
                               java.lang.String secret,
                               java.lang.String encSecret)
Return true when the given token is valid, and false in all other cases.
Parameters:
token - the sae token to verify.
secret - the shared secret to be used.
encSecret - the shared secret to be used.
Returns:
true if the token is valid.

getAttrFromSaeToken

public java.util.Map<java.lang.String,java.lang.String> getAttrFromSaeToken(java.lang.String token,
                                                                            java.lang.String secret,
                                                                            java.lang.String encSecret)
Return the Attributes Map from the given token.
Parameters:
token - the sae token to verify.
secret - the shared secret to be used.
encSecret - the shared secret to be used.
Returns:
true if the token is valid.ttribute Map if token is valid, null in other cases

getSaeToken

public java.lang.String getSaeToken(java.util.Map<java.lang.String,java.lang.String> hashmap,
                                    java.lang.String secret,
                                    java.lang.String encSecret)
                             throws RPClientException
Return the sae token using the given elements.
Parameters:
applicationID -
elt -
Returns:
Throws:
RPClientException

Skip navigation links

Copyright (c) 2012,
Oracle All Rights Reserved.
Built 06/05/2012 17:18:07 PDT