Package COM.TIBCO.hawk.console.security

Interface HsAgentInterface

public interface HsAgentInterface
The HsAgent interface is used to build a security implementation class for the TIB/Hawk agent. To build a security implementation, write a class that implements the HsAgentInterface.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    describe()
    All implementers must provide a description of themselves.
    void
    initialize()
    Called from the TIB/Hawk Agent to initialize the security plug-in.
    void
    shutdown()
    Called from the TIB/Hawk Agent to shutdown the security plug-in.
    HsUnpackedOperation
    unpack(HsPackedOperation operation)
    Called from within the TIB/Hawk agent to unpack every request into plaintext form.
    boolean
    validateId(HsIdentifier id, HsOperation operation)
    Called by the TIB/Hawk agent to validate and authorize each request.

  • Method Details

    • initialize

      void initialize() throws HsException
      Called from the TIB/Hawk Agent to initialize the security plug-in. Since the TIB/Hawk agent runs as a service or daemon, it is not possible to perform interactive activities from within the plug-in. This method will not called again until shutdown() is successful.
      Throws:
      HsException - is thrown by the plug-in to indicate an error error.

    • shutdown

      void shutdown() throws HsException
      Called from the TIB/Hawk Agent to shutdown the security plug-in. Since the TIB/Hawk agent runs as a service or daemon, it is not possible to perform interactive activities from within the plug-in. This method will not be called again until initialize() is successful.
      Throws:
      HsException - is thrown by the plug-in to indicate an error error.

    • unpack

      HsUnpackedOperation unpack(HsPackedOperation operation) throws HsException
      Called from within the TIB/Hawk agent to unpack every request into plaintext form.
      Parameters:
      operation - The signed request
      Throws:
      HsException - is thrown by the plug-in to indicate an error error.

    • validateId

      boolean validateId(HsIdentifier id, HsOperation operation) throws HsException
      Called by the TIB/Hawk agent to validate and authorize each request.
      Parameters:
      id - The security object that was produced by unpack().
      operation - The plaintext request produced by unpack().
      Throws:
      HsException - is thrown by the plug-in to indicate an error error.

    • describe

      String describe()
      All implementers must provide a description of themselves. This description is printed to stdout (or log files) any time the security policy is set or changed.