Package COM.TIBCO.hawk.console.security

Interface HsConsoleInterface

public interface HsConsoleInterface
The HsConsole interface is used to build a security implementation class for TIB/Hawk console applications. To build a security implementation, write a class that implements the HsConsoleInterface.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    CONSOLE
     
    static final int
    DAEMON
     
    static final int
    WINDOW
     

  • Method Summary

    Modifier and Type
    Method
    Description
    HsIdentifier
    createId(HsOperation operation)
    Called from the TIB/Hawk Console API to obtain identification information needed to pack a message into secure form.
    String
    describe()
    All implementers must provide a description of themselves.
    String
    initialize(int context)
    Called via the Console API to initialize the security plug-in.
    HsPackedOperation
    pack(HsIdentifier id, HsOperation operation)
    Called from the TIB/Hawk Console API to transform every request into secure form.
    void
    shutdown(int context)
    Called via the Console API to shutdown the security plug-in.

  • Field Details

  • Method Details

    • initialize

      String initialize(int context) throws HsException
      Called via the Console API to initialize the security plug-in. This method will not called again until shutdown() is successful.
      Parameters:
      the - context of the invoker. Possible contexts are WINDOW which indicates an interactive windowing environment. It is possible to perform interactive activities from within this context. CONSOLE which indicates an interactive console session. It is also possible to perform interactive command-line activities from withint this context. DAEMON which indicates a non-interactive batch or background process. It is not possible to perform interactive activites from within this context.
      Throws:
      HsException - is thrown by the plug-in to indicate an error. and error.

    • shutdown

      void shutdown(int context) throws HsException
      Called via the Console API to shutdown the security plug-in. This method will not called again until initialize() is successful.
      Parameters:
      the - context of the invoker. Possible contexts are WINDOW which indicates an interactive windowing environment. It is possible to perform interactive activities from within this context. CONSOLE which indicates an interactive console session. It is also possible to perform interactive command-line activities from withint this context. DAEMON which indicates a non-interactive batch or background process. It is not possible to perform interactive activites from within this context.
      Throws:
      HsException - is thrown by the plug-in to indicate an error. and error.

    • createId

      HsIdentifier createId(HsOperation operation) throws HsException
      Called from the TIB/Hawk Console API to obtain identification information needed to pack a message into secure form.
      Parameters:
      request - The object containing the operation request.
      Throws:
      HsException - is thrown by the plug-in to indicate an error. and error.

    • pack

      HsPackedOperation pack(HsIdentifier id, HsOperation operation) throws HsException
      Called from the TIB/Hawk Console API to transform every request into secure form.
      Parameters:
      id - The security object that was produced by createId().
      operation - The object containing the request.
      Throws:
      HsException - is thrown by the plug-in to indicate an error. and 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.