KeyManagersType (Apache CXF JavaDoc 3.0.4.redhat-621177 API)

org.apache.cxf.configuration.security

## Class KeyManagersType

- java.lang.Object
- - org.apache.cxf.configuration.security.KeyManagersType

-     public class KeyManagersType
      extends Object

  This structure specifies the JSSE based KeyManagers for a single Keystore.

  Java class for KeyManagersType complex type.

  The following schema fragment specifies the expected content contained within this class.

       <complexType name="KeyManagersType">
         <complexContent>
           <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
             <sequence>
               <element name="keyStore" type="{http://cxf.apache.org/configuration/security}KeyStoreType" minOccurs="0"/>
             </sequence>
             <attribute name="keyPassword" type="{http://www.w3.org/2001/XMLSchema}string" />
             <attribute name="provider" type="{http://www.w3.org/2001/XMLSchema}string" />
             <attribute name="factoryAlgorithm" type="{http://www.w3.org/2001/XMLSchema}string" />
             <attribute name="ref" type="{http://www.w3.org/2001/XMLSchema}string" />
           </restriction>
         </complexContent>
       </complexType>

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `protected String` | `factoryAlgorithm` This attribute contains the algorithm the KeyManagers Factory will use in creating the KeyManagers from the KeyStore.
    `protected String` | `keyPassword` This attribute contains the password that unlocks the keys within the keystore.
    `protected KeyStoreType` | `keyStore` This element specified the Keystore for these JSSE KeyManagers.
    `protected String` | `provider` This attribute contains the KeyManagers provider name.
    `protected String` | `ref` This attribute contains the reference to the KeyManagers bean.

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `KeyManagersType()`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `String` | `getFactoryAlgorithm()` Gets the value of the factoryAlgorithm property.
    `String` | `getKeyPassword()` Gets the value of the keyPassword property.
    `KeyStoreType` | `getKeyStore()` Gets the value of the keyStore property.
    `String` | `getProvider()` Gets the value of the provider property.
    `String` | `getRef()` Gets the value of the ref property.
    `boolean` | `isSetFactoryAlgorithm()`
    `boolean` | `isSetKeyPassword()`
    `boolean` | `isSetKeyStore()`
    `boolean` | `isSetProvider()`
    `boolean` | `isSetRef()`
    `void` | `setFactoryAlgorithm(String value)` Sets the value of the factoryAlgorithm property.
    `void` | `setKeyPassword(String value)` Sets the value of the keyPassword property.
    `void` | `setKeyStore(KeyStoreType value)` Sets the value of the keyStore property.
    `void` | `setProvider(String value)` Sets the value of the provider property.
    `void` | `setRef(String value)` Sets the value of the ref property.

    - ### Methods inherited from class java.lang.Object

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

- - ### Field Detail

    - #### keyStore

          protected KeyStoreType keyStore

      This element specified the Keystore for these JSSE KeyManagers.

    - #### keyPassword

          protected String keyPassword

      This attribute contains the password that unlocks the keys within the keystore.

    - #### provider

          protected String provider

      This attribute contains the KeyManagers provider name.

    - #### factoryAlgorithm

          protected String factoryAlgorithm

      This attribute contains the algorithm the KeyManagers Factory will use in creating the KeyManagers from the KeyStore. Most common examples are "PKIX".

    - #### ref

          protected String ref

      This attribute contains the reference to the KeyManagers bean. This attribute allows the KeyManagers instance to be constructed by other means and referenced from this object.

  - ### Constructor Detail

    - #### KeyManagersType

          public KeyManagersType()

  - ### Method Detail

    - #### getKeyStore

          public KeyStoreType getKeyStore()

      Gets the value of the keyStore property.

      This element specified the Keystore for these JSSE KeyManagers.

      Returns:
        possible object is `KeyStoreType`

    - #### setKeyStore

          public void setKeyStore(KeyStoreType value)

      Sets the value of the keyStore property.
      Parameters:
        `value` - allowed object is `KeyStoreType`
      See Also:
        `getKeyStore()`

    - #### isSetKeyStore

          public boolean isSetKeyStore()

    - #### getKeyPassword

          public String getKeyPassword()

      Gets the value of the keyPassword property.

      This attribute contains the password that unlocks the keys within the keystore.

      Returns:
        possible object is `String`

    - #### setKeyPassword

          public void setKeyPassword(String value)

      Sets the value of the keyPassword property.
      Parameters:
        `value` - allowed object is `String`
      See Also:
        `getKeyPassword()`

    - #### isSetKeyPassword

          public boolean isSetKeyPassword()

    - #### getProvider

          public String getProvider()

      Gets the value of the provider property.

      This attribute contains the KeyManagers provider name.

      Returns:
        possible object is `String`

    - #### setProvider

          public void setProvider(String value)

      Sets the value of the provider property.
      Parameters:
        `value` - allowed object is `String`
      See Also:
        `getProvider()`

    - #### isSetProvider

          public boolean isSetProvider()

    - #### getFactoryAlgorithm

          public String getFactoryAlgorithm()

      Gets the value of the factoryAlgorithm property.

      This attribute contains the algorithm the KeyManagers Factory will use in creating the KeyManagers from the KeyStore. Most common examples are "PKIX".

      Returns:
        possible object is `String`

    - #### setFactoryAlgorithm

          public void setFactoryAlgorithm(String value)

      Sets the value of the factoryAlgorithm property.
      Parameters:
        `value` - allowed object is `String`
      See Also:
        `getFactoryAlgorithm()`

    - #### isSetFactoryAlgorithm

          public boolean isSetFactoryAlgorithm()

    - #### getRef

          public String getRef()

      Gets the value of the ref property.

      This attribute contains the reference to the KeyManagers bean. This attribute allows the KeyManagers instance to be constructed by other means and referenced from this object.

      Returns:
        possible object is `String`

    - #### setRef

          public void setRef(String value)

      Sets the value of the ref property.
      Parameters:
        `value` - allowed object is `String`
      See Also:
        `getRef()`

    - #### isSetRef

          public boolean isSetRef()

Apache CXF