com.ibm.as400.access

Class ProfileHandleImplNative

  • java.lang.Object
    • com.ibm.as400.access.ProfileHandleImplNative
  • All Implemented Interfaces:
    ProfileHandleImpl


    public class ProfileHandleImplNative
    extends java.lang.Object
    implements ProfileHandleImpl
    The ProfileHandleImplNative class provides an implementation for behavior delegated by a ProfileHandleCredential object.
    • Method Summary

      Methods 
      Modifier and Type Method and Description
      void destroy()
      Destroy or clear sensitive information maintained by the credential implementation.
      byte[] getCurrentHandle()
      Generates and returns a profile handle based on the current thread identity.
      int getTimeToExpiration()
      Returns the number of seconds before the credential is due to expire.
      int getVersion()
      Returns the version number for the implementation.
      boolean isCurrent()
      Indicates if the credential is still considered valid for authenticating to associated services or performing related actions.
      void refresh()
      Updates or extends the validity period for the credential.
      void releaseHandle(byte[] handle)
      Releases OS resources for the given profile handle.
      void setCredential(AS400Credential credential)
      Sets the credential delegating behavior to the implementation object.
      void setCurrentHandle(byte[] handle)
      Sets the current thread identity based on the given profile handle.
      AS400Credential swap(boolean genRtnCr)
      Attempts to swap the thread identity based on this credential.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • ProfileHandleImplNative

        public ProfileHandleImplNative()
    >
    • Method Detail

      • destroy

        public void destroy()
                     throws DestroyFailedException
        Destroy or clear sensitive information maintained by the credential implementation.

        Subsequent requests may result in a NullPointerException.

        Subclasses should override as necessary to destroy or clear class-specific data.

        Throws:
        DestroyFailedException - If errors occur while destroying or clearing credential implementation data.
      • getTimeToExpiration

        public int getTimeToExpiration()
                                throws RetrieveFailedException
        Returns the number of seconds before the credential is due to expire.

        Subclasses implementing timed credentials must override.

        Returns:
        The number of seconds before expiration; zero (0) if already expired or if the credential is not identified as expiring based on time.
        Throws:
        RetrieveFailedException - If errors occur while retrieving timeout information.
      • getVersion

        public int getVersion()
        Returns the version number for the implementation.

        Used to ensure the implementation is valid for specific functions.

        Returns:
        The version number.
      • isCurrent

        public boolean isCurrent()
        Indicates if the credential is still considered valid for authenticating to associated services or performing related actions.

        An exception is not thrown on failure to remain consistent with the Refreshable interface (even though some credential classes currently avoid the dependency established by implementing the interface).

        Returns:
        true if valid; false if not valid or if the operation fails.
      • releaseHandle

        public void releaseHandle(byte[] handle)
                           throws DestroyFailedException
        Releases OS resources for the given profile handle.
        Parameters:
        handle - The handle bytes.
        Throws:
        DestroyFailedException - If errors occur while releasing the handle.
      • setCredential

        public void setCredential(AS400Credential credential)
        Sets the credential delegating behavior to the implementation object.
        Parameters:
        credential - The associated credential.
      • setCurrentHandle

        public void setCurrentHandle(byte[] handle)
                              throws SwapFailedException
        Sets the current thread identity based on the given profile handle.
        Parameters:
        handle - The handle bytes.
        Throws:
        SwapFailedException - If errors occur while generating the handle.
      • swap

        public AS400Credential swap(boolean genRtnCr)
                             throws SwapFailedException
        Attempts to swap the thread identity based on this credential.
        Parameters:
        genRtnCr - Indicates whether a return credential should be generated, even if supported. When appropriate, not generating a return credential can improve performance and avoid potential problems in creating the credential.
        Returns:
        A credential capable of swapping back to the original identity; classes not supporting this capability will return null. This value will also be null if genRtnCr is false.
        Throws:
        SwapFailedException - If errors occur while swapping thread identity.
        java.lang.SecurityException - If the caller does not have permission to modify the OS thread identity.