WCKeyBaseImpl

java.lang.Object
- com.ibm.commerce.security.keys.WCKeyBaseImpl

All Implemented Interfaces:

WCKey
```
public abstract class WCKeyBaseImpl
extends java.lang.Object
implements WCKey
```
This base class implementation provides default implementation for some of the WCKey interface methods.

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String COPYRIGHT
IBM copyright notice field.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`COPYRIGHT` IBM copyright notice field.

Constructor Summary

Constructors
Constructor and Description

WCKeyBaseImpl()

Constructors
Constructor and Description
`WCKeyBaseImpl()`

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAlgorithm()` Gets the algorithm of this key.
`java.lang.String`	`getName()` Retrieves the name of this Key.
`java.util.HashMap`	`getProperties()` Gets the configuration data that is used during the retrieval of the key.
`java.lang.String`	`getProvider()` Gets the name of the provider.
`java.lang.String`	`getStatus()` Gets the status of this key.
`java.lang.String`	`getVersion()` Gets the version of this key.
`java.lang.String`	`getWorkingDirectory()` Gets the directory, relative to which any key files will be stored.
`void`	`setAlgorithm(java.lang.String strAlgorithm)` Sets the algorithm of this key.
`void`	`setName(java.lang.String strKeyName)` Sets the name of the key in the WCKeyRegistry.
`void`	`setProperties(java.util.HashMap properties)` Sets the configuration properties that may be used by this class while retrieving the value of the key.
`void`	`setProvider(java.lang.String strProviderName)` Sets the name of the provider who implemented this particular key.
`void`	`setStatus(java.lang.String strStatus)` Sets the status of this key.
`void`	`setVersion(java.lang.String strVersion)` Sets the version of this key.
`void`	`setWorkingDirectory(java.lang.String strWorkingDirectory)` Sets the directory relative to which any key files will be stored.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.ibm.commerce.security.keys.WCKey
getEncryptedValueAsBytes, getEncryptedValueAsString, getNewEncryptedValueAsBytes, getNewEncryptedValueAsString, getNewValueAsBytes, getNewValueAsString, getValueAsBytes, getValueAsString, initialize, updateValue

- Field Detail
  - COPYRIGHT
```
public static final java.lang.String COPYRIGHT
```
    IBM copyright notice field.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - WCKeyBaseImpl
```
public WCKeyBaseImpl()
```
- Method Detail
  - setName
```
public void setName(java.lang.String strKeyName)
```
    Description copied from interface: WCKey
    
    Sets the name of the key in the WCKeyRegistry. Clients can query the service with this name to retrieve a particular key.
    
    Specified by:
    
    setName in interface WCKey
    
    Parameters:
    
    strKeyName - The name of the key.
    
    See Also:
    
    WCKey.setName(String)
  - getName
```
public java.lang.String getName()
```
    Description copied from interface: WCKey
    
    Retrieves the name of this Key.
    
    Specified by:
    
    getName in interface WCKey
    
    Returns:
    
    The name of key.
    
    See Also:
    
    WCKey.getName()
  - setProvider
```
public void setProvider(java.lang.String strProviderName)
```
    Description copied from interface: WCKey
    
    Sets the name of the provider who implemented this particular key.
    
    Specified by:
    
    setProvider in interface WCKey
    
    Parameters:
    
    strProviderName - The provider name.
    
    See Also:
    
    WCKey.setProvider(String)
  - setWorkingDirectory
```
public void setWorkingDirectory(java.lang.String strWorkingDirectory)
```
    Description copied from interface: WCKey
    
    Sets the directory relative to which any key files will be stored. By default this is the directory where the Keys Configuration File is stored.
    
    Specified by:
    
    setWorkingDirectory in interface WCKey
    
    Parameters:
    
    strWorkingDirectory - The directory relative to which any key files will be stored.
    
    See Also:
    
    WCKey.setWorkingDirectory(String)
  - getProvider
```
public java.lang.String getProvider()
```
    Gets the name of the provider.
    
    Specified by:
    
    getProvider in interface WCKey
    
    Returns:
    
    The name of provider.
  - setStatus
```
public void setStatus(java.lang.String strStatus)
```
    Sets the status of this key.
    
    Specified by:
    
    setStatus in interface WCKey
    
    Parameters:
    
    strStatus - The status of the key: "current" or "new"
  - getStatus
```
public java.lang.String getStatus()
```
    Gets the status of this key.
    
    Specified by:
    
    getStatus in interface WCKey
    
    Returns:
    
    The status of the key.
  - setVersion
```
public void setVersion(java.lang.String strVersion)
```
    Sets the version of this key.
    
    Specified by:
    
    setVersion in interface WCKey
    
    Parameters:
    
    strVersion - The version of the key.
  - getVersion
```
public java.lang.String getVersion()
```
    Description copied from interface: WCKey
    
    Gets the version of this key. Initially the version may be null.
    
    Specified by:
    
    getVersion in interface WCKey
    
    Returns:
    
    The version of the key. Initially the version may be null.
    
    See Also:
    
    WCKey.getVersion()
  - getWorkingDirectory
```
public java.lang.String getWorkingDirectory()
```
    Description copied from interface: WCKey
    
    Gets the directory, relative to which any key files will be stored. By default this is the directory where the Keys Configuration File is located.
    
    Specified by:
    
    getWorkingDirectory in interface WCKey
    
    Returns:
    
    Any key files will be stored relative to this directory
    
    See Also:
    
    WCKey.getWorkingDirectory()
  - setProperties
```
public void setProperties(java.util.HashMap properties)
```
    Description copied from interface: WCKey
    
    Sets the configuration properties that may be used by this class while retrieving the value of the key.
    
    Specified by:
    
    setProperties in interface WCKey
    
    Parameters:
    
    properties - The name-value pair of configuration properties.
    
    See Also:
    
    WCKey.setProperties(HashMap)
  - getProperties
```
public java.util.HashMap getProperties()
```
    Description copied from interface: WCKey
    
    Gets the configuration data that is used during the retrieval of the key.
    
    Specified by:
    
    getProperties in interface WCKey
    
    Returns:
    
    The configuration properties.
    
    See Also:
    
    WCKey.getProperties()
  - setAlgorithm
```
public void setAlgorithm(java.lang.String strAlgorithm)
```
    Sets the algorithm of this key.
    
    Specified by:
    
    setAlgorithm in interface WCKey
    
    Parameters:
    
    strAlgorithm - The algorithm of the key.
  - getAlgorithm
```
public java.lang.String getAlgorithm()
```
    Description copied from interface: WCKey
    
    Gets the algorithm of this key. By default the algorithm is null.
    
    Specified by:
    
    getAlgorithm in interface WCKey
    
    Returns:
    
    The algorithm of the key. By default the algorithm is null.
    
    See Also:
    
    WCKey.getAlgorithm()

Class WCKeyBaseImpl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.ibm.commerce.security.keys.WCKey

Field Detail

COPYRIGHT

Constructor Detail

WCKeyBaseImpl

Method Detail

setName

getName

setProvider

setWorkingDirectory

getProvider

setStatus

getStatus

setVersion

getVersion

getWorkingDirectory

setProperties

getProperties

setAlgorithm

getAlgorithm