com.ibm.cics.server

Class CertificateInfo



  • public class CertificateInfo
    extends API

    This Class provides the Java implementation of CICS API command EXTRACT CERTIFICATE.

    The protected constructor obtains the full certificate and the getter methods return the individual values contained within the full certificate.

    See Also:
    com.ibm.cics.server.API for general restrictions on using the JCICS API.
    Since CICS TS version:
    2.3
    Since package version:
    1.0
    • Field Summary

      Fields 
      Modifier and Type Field and Description
      static int ISSUER
      Constant - ISSUER
      static int OWNER
      Constant - OWNER
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      byte[] getCertificate()
      Usage:
      Returns the full certificate obtained by the constructor.
      java.lang.String getCommonName()
      Usage:
      Returns the common name from the client certificate obtained by the constructor.
      java.lang.String getCountry()
      Usage:
      Returns the country from the client certificate obtained by the constructor.
      java.lang.String getLocality()
      Usage:
      Returns the locality from the client certificate obtained by the constructor.
      java.lang.String getOrganization()
      Usage:
      Returns the organization from the client certificate obtained by the constructor.
      java.lang.String getOrgUnit()
      Usage:
      Returns the organization unit from the client certificate obtained by the constructor.
      java.lang.String getSerialNum()
      Usage:
      Returns the serial number of the certificate assigned by the certificate issuer obtained by the constructor.
      java.lang.String getState()
      Usage:
      Returns the state or province from the client certificate obtained by the constructor.
      java.lang.String getUserID()
      Usage:
      Returns the user-id connected with the client certificate obtained by the constructor.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Method Detail

      • getCertificate

        public byte[] getCertificate()
        Usage:
        Returns the full certificate obtained by the constructor. This is equivalent to CICS API command EXTRACT CERTIFICATE.
        Returns:
        The full certificate
        Since CICS TS version:
        2.3
        Since package version:
        1.0
      • getSerialNum

        public java.lang.String getSerialNum()
        Usage:
        Returns the serial number of the certificate assigned by the certificate issuer obtained by the constructor. This is equivalent to CICS API command EXTRACT CERTIFICATE SERIALNUM.
        Returns:
        The serial number
        Since CICS TS version:
        2.3
        Since package version:
        1.0
      • getUserID

        public java.lang.String getUserID()
        Usage:
        Returns the user-id connected with the client certificate obtained by the constructor. This is equivalent to CICS API command EXTRACT CERTIFICATE USERID.
        Returns:
        The user-id
        Since CICS TS version:
        2.3
        Since package version:
        1.0
      • getCommonName

        public java.lang.String getCommonName()
        Usage:
        Returns the common name from the client certificate obtained by the constructor. This is equivalent to CICS API command EXTRACT CERTIFICATE COMMONNAME.
        Returns:
        The common name
        Since CICS TS version:
        2.3
        Since package version:
        1.0
      • getCountry

        public java.lang.String getCountry()
        Usage:
        Returns the country from the client certificate obtained by the constructor. This is equivalent to CICS API command EXTRACT CERTIFICATE COUNTRY.
        Returns:
        The country
        Since CICS TS version:
        2.3
        Since package version:
        1.0
      • getState

        public java.lang.String getState()
        Usage:
        Returns the state or province from the client certificate obtained by the constructor. This is equivalent to CICS API command EXTRACT CERTIFICATE STATE.
        Returns:
        The state
        Since CICS TS version:
        2.3
        Since package version:
        1.0
      • getLocality

        public java.lang.String getLocality()
        Usage:
        Returns the locality from the client certificate obtained by the constructor. This is equivalent to CICS API command EXTRACT CERTIFICATE LOCALITY.
        Returns:
        The locality
        Since CICS TS version:
        2.3
        Since package version:
        1.0
      • getOrganization

        public java.lang.String getOrganization()
        Usage:
        Returns the organization from the client certificate obtained by the constructor. This is equivalent to CICS API command EXTRACT CERTIFICATE ORGANIZATION.
        Returns:
        The organization
        Since CICS TS version:
        2.3
        Since package version:
        1.0
      • getOrgUnit

        public java.lang.String getOrgUnit()
        Usage:
        Returns the organization unit from the client certificate obtained by the constructor. This is equivalent to CICS API command EXTRACT CERTIFICATE ORGUNIT.
        Returns:
        The organization unit
        Since CICS TS version:
        2.3
        Since package version:
        1.0