Package com.netscape.cmscore.base

Class ArgBlock

  • All Implemented Interfaces:
    IArgBlock, java.io.Serializable
    public class ArgBlock
extends java.lang.Object
implements IArgBlock
    This class represents a set of indexed arguments. Each argument is indexed by a key, which can be used during the argument retrieval.
    Version:
    $Revision$, $Date$
    See Also:
    Serialized Form

    • Constructor Summary

      Constructors 
      Constructor Description
      ArgBlock()
      Constructs an empty argument block.
      ArgBlock​(java.lang.String realm, java.util.Hashtable<java.lang.String,​java.lang.String> httpReq)
      Constructs an argument block with the given hashtable values.
      ArgBlock​(java.util.Hashtable<java.lang.String,​java.lang.String> httpReq)
      Constructs an argument block with the given hashtable values.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.Object addBigIntegerValue​(java.lang.String n, java.math.BigInteger v, int radix)
      Adds integer-type arguments to this block.
      java.lang.Object addBooleanValue​(java.lang.String n, boolean v)
      Adds boolean-type arguments to this block.
      java.lang.Object addIntegerValue​(java.lang.String n, int v)
      Adds integer-type arguments to this block.
      java.lang.Object addLongValue​(java.lang.String n, long v)
      Adds long-type arguments to this block.
      java.lang.Object addStringValue​(java.lang.String n, java.lang.String v)
      Adds string-based value into this argument block.
      void delete​(java.lang.String name)
      Deletes argument by the given key.
      java.util.Enumeration<java.lang.String> elements()
      Retrieves a list of argument keys.
      java.lang.Object get​(java.lang.String name)
      Retrieves argument.
      java.util.Enumeration<java.lang.String> getElements()
      Retrieves a list of argument keys.
      java.lang.Object getValue​(java.lang.Object n)
      Retrieves argument value as object
      java.lang.Object getValue​(java.lang.Object n, java.lang.Object def)
      Retrieves argument value as object
      java.math.BigInteger getValueAsBigInteger​(java.lang.String n)
      Retrieves argument value as big integer.
      java.math.BigInteger getValueAsBigInteger​(java.lang.String n, java.math.BigInteger def)
      Retrieves argument value as big integer.
      boolean getValueAsBoolean​(java.lang.String name)
      Gets boolean value.
      boolean getValueAsBoolean​(java.lang.String name, boolean def)
      Gets boolean value.
      int getValueAsInt​(java.lang.String n)
      Retrieves argument value as integer.
      int getValueAsInt​(java.lang.String n, int def)
      Retrieves argument value as integer.
      KeyGenInfo getValueAsKeyGenInfo​(java.lang.String name, KeyGenInfo def)
      Gets KeyGenInfo
      org.mozilla.jss.netscape.security.pkcs.PKCS10 getValueAsPKCS10​(java.lang.String name, boolean checkheader)
      Retrieves PKCS10
      org.mozilla.jss.netscape.security.pkcs.PKCS10 getValueAsPKCS10​(java.lang.String name, boolean checkheader, org.mozilla.jss.netscape.security.pkcs.PKCS10 def)
      Retrieves PKCS10
      org.mozilla.jss.netscape.security.pkcs.PKCS10 getValueAsRawPKCS10​(java.lang.String name)
      Gets PKCS10 request.
      org.mozilla.jss.netscape.security.pkcs.PKCS10 getValueAsRawPKCS10​(java.lang.String name, org.mozilla.jss.netscape.security.pkcs.PKCS10 def)
      Gets PKCS10 request.
      java.lang.String getValueAsString​(java.lang.String n)
      Retrieves argument value as string.
      java.lang.String getValueAsString​(java.lang.String n, java.lang.String def)
      Retrieves argument value as string.
      org.mozilla.jss.netscape.security.pkcs.PKCS10 getValuePKCS10​(java.lang.String name, org.mozilla.jss.netscape.security.pkcs.PKCS10 def)
      Retrieves PKCS10
      boolean isValuePresent​(java.lang.String n)
      Checks if this argument block contains the given key.
      void set​(java.lang.String name, java.lang.Object ob)
      Sets argument into this block.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • logger

        public static org.slf4j.Logger logger

      • CERT_NEW_REQUEST_HEADER

        public static final java.lang.String CERT_NEW_REQUEST_HEADER
        See Also:
        Constant Field Values

      • CERT_NEW_REQUEST_TRAILER

        public static final java.lang.String CERT_NEW_REQUEST_TRAILER
        See Also:
        Constant Field Values

      • CERT_RENEWAL_HEADER

        public static final java.lang.String CERT_RENEWAL_HEADER
        See Also:
        Constant Field Values

      • CERT_RENEWAL_TRAILER

        public static final java.lang.String CERT_RENEWAL_TRAILER
        See Also:
        Constant Field Values

    • Constructor Detail

      • ArgBlock

        public ArgBlock​(java.lang.String realm,
                java.util.Hashtable<java.lang.String,​java.lang.String> httpReq)
        Constructs an argument block with the given hashtable values.
        Parameters:
        realm - the type of argblock - used for debugging the values

      • ArgBlock

        public ArgBlock​(java.util.Hashtable<java.lang.String,​java.lang.String> httpReq)
        Constructs an argument block with the given hashtable values.
        Parameters:
        httpReq - hashtable keys and values

      • ArgBlock

        public ArgBlock()
        Constructs an empty argument block.

    • Method Detail

      • isValuePresent

        public boolean isValuePresent​(java.lang.String n)
        Checks if this argument block contains the given key.
        Specified by:
        isValuePresent in interface IArgBlock
        Parameters:
        n - key
        Returns:
        true if key is present

      • addStringValue

        public java.lang.Object addStringValue​(java.lang.String n,
                                       java.lang.String v)
        Adds string-based value into this argument block.
        Specified by:
        addStringValue in interface IArgBlock
        Parameters:
        n - key
        v - value
        Returns:
        value

      • getValueAsString

        public java.lang.String getValueAsString​(java.lang.String n)
                                  throws EBaseException
        Retrieves argument value as string.
        Specified by:
        getValueAsString in interface IArgBlock
        Parameters:
        n - key
        Returns:
        argument value as string
        Throws:
        EBaseException - failed to retrieve value

      • getValueAsString

        public java.lang.String getValueAsString​(java.lang.String n,
                                         java.lang.String def)
        Retrieves argument value as string.
        Specified by:
        getValueAsString in interface IArgBlock
        Parameters:
        n - key
        def - default value to be returned if key is not present
        Returns:
        argument value as string

      • getValueAsInt

        public int getValueAsInt​(java.lang.String n)
                  throws EBaseException
        Retrieves argument value as integer.
        Specified by:
        getValueAsInt in interface IArgBlock
        Parameters:
        n - key
        Returns:
        argument value as int
        Throws:
        EBaseException - failed to retrieve value

      • getValueAsInt

        public int getValueAsInt​(java.lang.String n,
                         int def)
        Retrieves argument value as integer.
        Specified by:
        getValueAsInt in interface IArgBlock
        Parameters:
        n - key
        def - default value to be returned if key is not present
        Returns:
        argument value as int

      • getValueAsBigInteger

        public java.math.BigInteger getValueAsBigInteger​(java.lang.String n)
                                          throws EBaseException
        Retrieves argument value as big integer.
        Specified by:
        getValueAsBigInteger in interface IArgBlock
        Parameters:
        n - key
        Returns:
        argument value as big integer
        Throws:
        EBaseException - failed to retrieve value

      • getValueAsBigInteger

        public java.math.BigInteger getValueAsBigInteger​(java.lang.String n,
                                                 java.math.BigInteger def)
        Retrieves argument value as big integer.
        Specified by:
        getValueAsBigInteger in interface IArgBlock
        Parameters:
        n - key
        def - default value to be returned if key is not present
        Returns:
        argument value as big integer

      • getValue

        public java.lang.Object getValue​(java.lang.Object n)
                          throws EBaseException
        Retrieves argument value as object
        Specified by:
        getValue in interface IArgBlock
        Parameters:
        n - key
        Returns:
        argument value as object
        Throws:
        EBaseException - failed to retrieve value

      • getValue

        public java.lang.Object getValue​(java.lang.Object n,
                                 java.lang.Object def)
        Retrieves argument value as object
        Specified by:
        getValue in interface IArgBlock
        Parameters:
        n - key
        def - default value to be returned if key is not present
        Returns:
        argument value as object

      • getValueAsBoolean

        public boolean getValueAsBoolean​(java.lang.String name)
                          throws EBaseException
        Gets boolean value. They should be "true" or "false".
        Specified by:
        getValueAsBoolean in interface IArgBlock
        Parameters:
        name - name of the input type
        Returns:
        boolean type: true or false
        Throws:
        EBaseException - failed to retrieve value

      • getValueAsBoolean

        public boolean getValueAsBoolean​(java.lang.String name,
                                 boolean def)
        Gets boolean value. They should be "true" or "false".
        Specified by:
        getValueAsBoolean in interface IArgBlock
        Parameters:
        name - name of the input type
        def - Default value to return.
        Returns:
        boolean type: true or false

      • getValueAsRawPKCS10

        public org.mozilla.jss.netscape.security.pkcs.PKCS10 getValueAsRawPKCS10​(java.lang.String name)
                                                                  throws EBaseException
        Gets PKCS10 request. This pkcs10 attribute does not contain header information.
        Specified by:
        getValueAsRawPKCS10 in interface IArgBlock
        Parameters:
        name - name of the input type
        Returns:
        pkcs10 request
        Throws:
        EBaseException - failed to retrieve value

      • getValueAsRawPKCS10

        public org.mozilla.jss.netscape.security.pkcs.PKCS10 getValueAsRawPKCS10​(java.lang.String name,
                                                                         org.mozilla.jss.netscape.security.pkcs.PKCS10 def)
                                                                  throws EBaseException
        Gets PKCS10 request. This pkcs10 attribute does not contain header information.
        Specified by:
        getValueAsRawPKCS10 in interface IArgBlock
        Parameters:
        name - name of the input type
        def - default PKCS10
        Returns:
        pkcs10 request
        Throws:
        EBaseException - failed to retrieve value

      • getValueAsPKCS10

        public org.mozilla.jss.netscape.security.pkcs.PKCS10 getValueAsPKCS10​(java.lang.String name,
                                                                      boolean checkheader)
                                                               throws EBaseException
        Retrieves PKCS10
        Specified by:
        getValueAsPKCS10 in interface IArgBlock
        Parameters:
        name - name of the input type
        checkheader - true if header must be present
        Returns:
        PKCS10 object
        Throws:
        EBaseException - failed to retrieve value

      • getValueAsPKCS10

        public org.mozilla.jss.netscape.security.pkcs.PKCS10 getValueAsPKCS10​(java.lang.String name,
                                                                      boolean checkheader,
                                                                      org.mozilla.jss.netscape.security.pkcs.PKCS10 def)
                                                               throws EBaseException
        Retrieves PKCS10
        Specified by:
        getValueAsPKCS10 in interface IArgBlock
        Parameters:
        name - name of the input type
        checkheader - true if header must be present
        def - default PKCS10
        Returns:
        PKCS10 object
        Throws:
        EBaseException

      • getValuePKCS10

        public org.mozilla.jss.netscape.security.pkcs.PKCS10 getValuePKCS10​(java.lang.String name,
                                                                    org.mozilla.jss.netscape.security.pkcs.PKCS10 def)
                                                             throws EBaseException
        Retrieves PKCS10
        Specified by:
        getValuePKCS10 in interface IArgBlock
        Parameters:
        name - name of the input type
        def - default PKCS10
        Returns:
        PKCS10 object
        Throws:
        EBaseException

      • set

        public void set​(java.lang.String name,
                java.lang.Object ob)
        Sets argument into this block.
        Specified by:
        set in interface IArgBlock
        Parameters:
        name - key
        ob - value

      • get

        public java.lang.Object get​(java.lang.String name)
        Retrieves argument.
        Specified by:
        get in interface IArgBlock
        Parameters:
        name - key
        Returns:
        object value

      • delete

        public void delete​(java.lang.String name)
        Deletes argument by the given key.
        Specified by:
        delete in interface IArgBlock
        Parameters:
        name - key

      • getElements

        public java.util.Enumeration<java.lang.String> getElements()
        Retrieves a list of argument keys.
        Specified by:
        getElements in interface IArgBlock
        Returns:
        a list of string-based keys

      • elements

        public java.util.Enumeration<java.lang.String> elements()
        Retrieves a list of argument keys.
        Specified by:
        elements in interface IArgBlock
        Returns:
        a list of string-based keys

      • addLongValue

        public java.lang.Object addLongValue​(java.lang.String n,
                                     long v)
        Adds long-type arguments to this block.
        Specified by:
        addLongValue in interface IArgBlock
        Parameters:
        n - key
        v - value
        Returns:
        value

      • addIntegerValue

        public java.lang.Object addIntegerValue​(java.lang.String n,
                                        int v)
        Adds integer-type arguments to this block.
        Specified by:
        addIntegerValue in interface IArgBlock
        Parameters:
        n - key
        v - value
        Returns:
        value

      • addBooleanValue

        public java.lang.Object addBooleanValue​(java.lang.String n,
                                        boolean v)
        Adds boolean-type arguments to this block.
        Specified by:
        addBooleanValue in interface IArgBlock
        Parameters:
        n - key
        v - value
        Returns:
        value

      • addBigIntegerValue

        public java.lang.Object addBigIntegerValue​(java.lang.String n,
                                           java.math.BigInteger v,
                                           int radix)
        Adds integer-type arguments to this block.
        Specified by:
        addBigIntegerValue in interface IArgBlock
        Parameters:
        n - key
        v - value
        radix - radix
        Returns:
        value