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

Class JSMessageExtensionContext

  • public class JSMessageExtensionContext
extends java.lang.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");

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getHeader​(java.lang.String name)
      Get a HTTP header of the request which is triggering this SAML message.
      java.util.List<java.lang.String> getHeaderNames()
      Get a list of header names which were present in the request.
      java.util.List<java.lang.String> getInfoKeys()
      Get a list of keys which can be used in getInfoValue(name) calls.
      java.lang.String getInfoValue​(java.lang.String name)
      get a piece of informationa about the SAML context.
      java.lang.String getParameter​(java.lang.String name)
      Get a HTTP parameter of the request which is triggering this SAML message.
      java.util.List<java.lang.String> getParameterNames()
      Get a list of HTTP parameters which were present in the request.
      java.lang.String getUrl()
      Get the URL of the request which is triggering this SAML message.

      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • JSMessageExtensionContext

        public JSMessageExtensionContext​(XMLMessageExtensionInfo info)

    • Method Detail

      • getInfoKeys

        public java.util.List<java.lang.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 java.lang.String getInfoValue​(java.lang.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 java.util.List<java.lang.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 java.util.List<java.lang.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 java.lang.String getHeader​(java.lang.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 java.lang.String getParameter​(java.lang.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 java.lang.String getUrl()
        Get the URL of the request which is triggering this SAML message.