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

org.apache.cxf.configuration.security

## Class KeyStoreType

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

-     public class KeyStoreType
      extends Object

  A KeyStoreType represents the information needed to load a collection of key and certificate material from a desired location. The "url", "file", and "resource" attributes are intended to be mutually exclusive, though this assumption is not encoded in schema. The precedence order observed by the runtime is 1) "file", 2) "resource", and 3) "url".

  Java class for KeyStoreType complex type.

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

       <complexType name="KeyStoreType">
         <complexContent>
           <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
             <attribute name="type" type="{http://www.w3.org/2001/XMLSchema}string" />
             <attribute name="password" type="{http://www.w3.org/2001/XMLSchema}string" />
             <attribute name="provider" type="{http://www.w3.org/2001/XMLSchema}string" />
             <attribute name="url" type="{http://www.w3.org/2001/XMLSchema}string" />
             <attribute name="file" type="{http://www.w3.org/2001/XMLSchema}string" />
             <attribute name="resource" type="{http://www.w3.org/2001/XMLSchema}string" />
           </restriction>
         </complexContent>
       </complexType>

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `protected String` | `file` This attribute specifies the File location of the keystore.
    `protected String` | `password` This attribute specifes the integrity password for the keystore.
    `protected String` | `provider` This attribute specifies the keystore implementation provider.
    `protected String` | `resource` This attribute specifies the Resource location of the keystore.
    `protected String` | `type` This attribute specifies the type of the keystore.
    `protected String` | `url` This attribute specifies the URL location of the keystore.

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `KeyStoreType()`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `String` | `getFile()` Gets the value of the file property.
    `String` | `getPassword()` Gets the value of the password property.
    `String` | `getProvider()` Gets the value of the provider property.
    `String` | `getResource()` Gets the value of the resource property.
    `String` | `getType()` Gets the value of the type property.
    `String` | `getUrl()` Gets the value of the url property.
    `boolean` | `isSetFile()`
    `boolean` | `isSetPassword()`
    `boolean` | `isSetProvider()`
    `boolean` | `isSetResource()`
    `boolean` | `isSetType()`
    `boolean` | `isSetUrl()`
    `void` | `setFile(String value)` Sets the value of the file property.
    `void` | `setPassword(String value)` Sets the value of the password property.
    `void` | `setProvider(String value)` Sets the value of the provider property.
    `void` | `setResource(String value)` Sets the value of the resource property.
    `void` | `setType(String value)` Sets the value of the type property.
    `void` | `setUrl(String value)` Sets the value of the url property.

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

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

- - ### Field Detail

    - #### type

          protected String type

      This attribute specifies the type of the keystore. It is highly correlated to the provider. Most common examples are "jks" "pkcs12".

    - #### password

          protected String password

      This attribute specifes the integrity password for the keystore. This is not the password that unlock keys within the keystore.

    - #### provider

          protected String provider

      This attribute specifies the keystore implementation provider. Most common examples are "SUN".

    - #### url

          protected String url

      This attribute specifies the URL location of the keystore. This element should be a properly accessible URL, such as "http://..." "file:///...", etc. Only one attribute of "url", "file", or "resource" is allowed.

    - #### file

          protected String file

      This attribute specifies the File location of the keystore. This element should be a properly accessible file from the working directory. Only one attribute of "url", "file", or "resource" is allowed.

    - #### resource

          protected String resource

      This attribute specifies the Resource location of the keystore. This element should be a properly accessible on the classpath. Only one attribute of "url", "file", or "resource" is allowed.

  - ### Constructor Detail

    - #### KeyStoreType

          public KeyStoreType()

  - ### Method Detail

    - #### getType

          public String getType()

      Gets the value of the type property.

      This attribute specifies the type of the keystore. It is highly correlated to the provider. Most common examples are "jks" "pkcs12".

      Returns:
        possible object is `String`

    - #### setType

          public void setType(String value)

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

    - #### isSetType

          public boolean isSetType()

    - #### getPassword

          public String getPassword()

      Gets the value of the password property.

      This attribute specifes the integrity password for the keystore. This is not the password that unlock keys within the keystore.

      Returns:
        possible object is `String`

    - #### setPassword

          public void setPassword(String value)

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

    - #### isSetPassword

          public boolean isSetPassword()

    - #### getProvider

          public String getProvider()

      Gets the value of the provider property.

      This attribute specifies the keystore implementation provider. Most common examples are "SUN".

      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()

    - #### getUrl

          public String getUrl()

      Gets the value of the url property.

      This attribute specifies the URL location of the keystore. This element should be a properly accessible URL, such as "http://..." "file:///...", etc. Only one attribute of "url", "file", or "resource" is allowed.

      Returns:
        possible object is `String`

    - #### setUrl

          public void setUrl(String value)

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

    - #### isSetUrl

          public boolean isSetUrl()

    - #### getFile

          public String getFile()

      Gets the value of the file property.

      This attribute specifies the File location of the keystore. This element should be a properly accessible file from the working directory. Only one attribute of "url", "file", or "resource" is allowed.

      Returns:
        possible object is `String`

    - #### setFile

          public void setFile(String value)

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

    - #### isSetFile

          public boolean isSetFile()

    - #### getResource

          public String getResource()

      Gets the value of the resource property.

      This attribute specifies the Resource location of the keystore. This element should be a properly accessible on the classpath. Only one attribute of "url", "file", or "resource" is allowed.

      Returns:
        possible object is `String`

    - #### setResource

          public void setResource(String value)

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

    - #### isSetResource

          public boolean isSetResource()

Apache CXF