Interface IAuthzSubsystem

  • All Superinterfaces:
    ISubsystem
    All Known Implementing Classes:
    AuthzSubsystem

    public interface IAuthzSubsystem
    extends ISubsystem
    An interface that represents an authorization component

    Version:
    $Revision$, $Date$
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static java.lang.String ID
      Constant for auths.
      static java.lang.String PROP_CLASS
      Constant for class.
      static java.lang.String PROP_IMPL
      Constant for impl
      static java.lang.String PROP_PLUGIN
      Constant for pluginName.
      static java.lang.String PROP_REALM
      Constant for realm
    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      void add​(java.lang.String name, IAuthzManager authzMgr)
      Adds (registers) the given authorization manager.
      AuthzToken authorize​(java.lang.String authzMgrName, IAuthToken authToken, java.lang.String exp)  
      AuthzToken authorize​(java.lang.String authzMgrName, IAuthToken authToken, java.lang.String resource, java.lang.String operation)
      authorize the user associated with the given authToken for a given operation with the given authorization manager name
      AuthzToken authorize​(java.lang.String authzMgrName, IAuthToken authToken, java.lang.String resource, java.lang.String operation, java.lang.String realm)  
      void authzMgrAccessInit​(java.lang.String authzMgrName, java.lang.String accessInfo)
      Initialize authz info - usually used for BasicAclAuthz
      void checkRealm​(java.lang.String realm, IAuthToken authToken, java.lang.String owner, java.lang.String resource, java.lang.String operation)
      Authorize the user against the specified realm.
      void delete​(java.lang.String name)
      Deletes (deregisters) the given authorization manager.
      IAuthzManager get​(java.lang.String name)
      Get an authorization manager interface for the given name.
      IAuthzManager getAuthzManager​(java.lang.String name)
      Gets the Authorization manager instance of the specified name.
      java.lang.String getAuthzManagerNameByRealm​(java.lang.String realm)
      Given a realm name, return the name of an authz manager for that realm.
      IAuthzManager getAuthzManagerPlugin​(java.lang.String name)
      Gets a single authorization manager plugin implementation
      java.util.Enumeration<AuthzMgrPlugin> getAuthzManagerPlugins()
      Gets an enumeration of authorization manager plugins.
      java.util.Enumeration<IAuthzManager> getAuthzManagers()
      Gets an enumeration of authorization managers registered to the authorization component.
      java.util.Hashtable<java.lang.String,​AuthzManagerProxy> getInstances()
      Get a hashtable containing all authentication instances.
      java.util.Hashtable<java.lang.String,​AuthzMgrPlugin> getPlugins()
      Get a hashtable containing all authentication plugins.
    • Method Detail

      • authorize

        AuthzToken authorize​(java.lang.String authzMgrName,
                             IAuthToken authToken,
                             java.lang.String resource,
                             java.lang.String operation)
                      throws EBaseException
        authorize the user associated with the given authToken for a given operation with the given authorization manager name
        Parameters:
        authzMgrName - The authorization manager name
        authToken - the authenticaton token associated with a user
        resource - the resource protected by the authorization system
        operation - the operation for resource protected by the authorization system
        Returns:
        a authorization token.
        Throws:
        EBaseException - If an error occurs during authorization.
      • checkRealm

        void checkRealm​(java.lang.String realm,
                        IAuthToken authToken,
                        java.lang.String owner,
                        java.lang.String resource,
                        java.lang.String operation)
                 throws EBaseException
        Authorize the user against the specified realm. Looks for authz manager associated with the plugin and authenticates if present.
        Parameters:
        realm -
        authToken -
        owner - TODO
        resource -
        operation -
        Throws:
        EBaseException - if any error occurs during authentication.
      • add

        void add​(java.lang.String name,
                 IAuthzManager authzMgr)
        Adds (registers) the given authorization manager.
        Parameters:
        name - The authorization manager name
        authzMgr - The authorization manager instance.
      • delete

        void delete​(java.lang.String name)
        Deletes (deregisters) the given authorization manager.
        Parameters:
        name - The authorization manager name to delete.
      • getAuthzManager

        IAuthzManager getAuthzManager​(java.lang.String name)
                               throws EBaseException
        Gets the Authorization manager instance of the specified name.
        Parameters:
        name - The authorization manager's name.
        Returns:
        an authorization manager interface
        Throws:
        EBaseException
      • getAuthzManagers

        java.util.Enumeration<IAuthzManager> getAuthzManagers()
        Gets an enumeration of authorization managers registered to the authorization component.
        Returns:
        a list of authorization managers
      • authzMgrAccessInit

        void authzMgrAccessInit​(java.lang.String authzMgrName,
                                java.lang.String accessInfo)
                         throws EBaseException
        Initialize authz info - usually used for BasicAclAuthz
        Parameters:
        authzMgrName - name of the authorization manager
        accessInfo - string representation of the ACL
        Throws:
        EBaseException - if authorization manager is not found
      • getAuthzManagerPlugins

        java.util.Enumeration<AuthzMgrPlugin> getAuthzManagerPlugins()
        Gets an enumeration of authorization manager plugins.
        Returns:
        list of authorization manager plugins
      • getAuthzManagerPlugin

        IAuthzManager getAuthzManagerPlugin​(java.lang.String name)
        Gets a single authorization manager plugin implementation
        Parameters:
        name - given authorization plugin name
        Returns:
        authorization manager plugin
      • getPlugins

        java.util.Hashtable<java.lang.String,​AuthzMgrPlugin> getPlugins()
        Get a hashtable containing all authentication plugins.
        Returns:
        all authentication plugins.
      • getInstances

        java.util.Hashtable<java.lang.String,​AuthzManagerProxy> getInstances()
        Get a hashtable containing all authentication instances.
        Returns:
        all authentication instances.
      • get

        IAuthzManager get​(java.lang.String name)
        Get an authorization manager interface for the given name.
        Parameters:
        name - given authorization manager name.
        Returns:
        an authorization manager interface
      • getAuthzManagerNameByRealm

        java.lang.String getAuthzManagerNameByRealm​(java.lang.String realm)
                                             throws EAuthzUnknownRealm
        Given a realm name, return the name of an authz manager for that realm.
        Throws:
        EAuthzUnknownRealm - if no authz manager is found.