Interface ActionMapper

  • All Known Implementing Classes:
    FMActionMapper

    public interface ActionMapper
    This interface defines the SPI for pluggable implementations to map XACML context Action and native Action
    • Method Detail

      • initialize

        void initialize​(String pdpEntityId,
                        String pepEntityId,
                        Map properties)
                 throws XACMLException
        Initializes the mapper implementation. This would be called immediately after constructing an instance of the implementation.
        Parameters:
        pdpEntityId - EntityID of PDP
        pepEntityId - EntityID of PEP
        properties - configuration properties
        Throws:
        XACMLException - if can not initialize
      • mapToNativeAction

        String mapToNativeAction​(Action xacmlContextAction,
                                 String serviceName)
                          throws XACMLException
        Returns native action name
        Parameters:
        xacmlContextAction - XACML context Action
        serviceName - native service name the requested resource belongs to
        Returns:
        native action name
        Throws:
        XACMLException - if can not map to native action name
      • mapToXACMLAction

        Action mapToXACMLAction​(String nativeActionName,
                                String serviceName)
                         throws XACMLException
        Returns XACML context Action
        Parameters:
        nativeActionName - native action name
        serviceName - native service name the requested resource belongs to
        Returns:
        XACML context Action
        Throws:
        XACMLException - if can not map to XACML context Action
      • mapToXACMLActionEffect

        String mapToXACMLActionEffect​(String nativeActionEffect,
                                      String serviceName)
                               throws XACMLException
        Returns XACML context decision effect
        Parameters:
        nativeActionEffect - native action effect
        serviceName - native service name the requested resource belongs to
        Throws:
        XACMLException - if can not map to XACML context Action