Package com.tivoli.am.fim.saml20.protocol.extension.js

Class JSMessageExtensionContext

java.lang.Object
com.tivoli.am.fim.saml20.protocol.extension.js.JSMessageExtensionContext
public class JSMessageExtensionContext extends Object
Context provided in a SAML20 message extension rule. Will be provided as a variable 'context'. An example of usage is:
var lang = context.getHeader("Accept-Language");

  • Constructor Details

    • JSMessageExtensionContext

      public JSMessageExtensionContext(com.tivoli.am.fim.xml.extension.XMLMessageExtensionInfo info)

  • Method Details

    • getInfoKeys

      public List<String> getInfoKeys()
      Get a list of keys which can be used in getInfoValue(name) calls. These keys will include informationa about the SAML context.
      Returns:
      A list of strings which are valid in a getInfoValue(name) call.

    • getInfoValue

      public String getInfoValue(String name)
      get a piece of informationa about the SAML context. Use getInfoKeys() to get a list of valid keys. These keys will include things like:
      • Federation and Partner name
      • Federation and Partner role
      • Federation and Partner ID
      • Message Type
      • username
      • The query string of the initial request
      • Binding
      • Profile
      Returns:
      the info associated with the provided name.

    • getHeaderNames

      public List<String> getHeaderNames()
      Get a list of header names which were present in the request.
      Returns:
      a list of valid header names that can be used in a call to getHeader(name).

    • getParameterNames

      public List<String> getParameterNames()
      Get a list of HTTP parameters which were present in the request.
      Returns:
      a list of valid parameter names that can be used in a call to getParameter(name).

    • getHeader

      public String getHeader(String name)
      Get a HTTP header of the request which is triggering this SAML message.
      Parameters:
      name - of the header to retrieve.
      Returns:
      the header value.

    • getParameter

      public String getParameter(String name)
      Get a HTTP parameter of the request which is triggering this SAML message.
      Parameters:
      name - of the parameter to retrieve.
      Returns:
      the parameter value.

    • getUrl

      public String getUrl()
      Get the URL of the request which is triggering this SAML message.