com.novell.ecb.secretstore
Class RemoveSecretStore

java.lang.Object
  |
  +--com.novell.ecb.secretstore.SecretStoreBean
        |
        +--com.novell.ecb.secretstore.RemoveSecretStore

All Implemented Interfaces:

Command, java.io.Serializable

public class RemoveSecretStore

extends SecretStoreBean

Deletes the SecretStore.

Required Input Properties:

ssInstance - A SecretStoreInstance object that represents the SecretStore to be removed.

Optional Input Properties:

flags - The flags for the operation. Currently, no flag is defined for this operation. Property is provided here for future use.

Output Property:

None

Version:

1.0

See Also:

Serialized Form

Field Summary

Fields inherited from class com.novell.ecb.secretstore.SecretStoreBean

MAX_BUFFER_SIZE

Constructor Summary

RemoveSecretStore()
Constructs a RemoveSecretStore command bean.

RemoveSecretStore(SecretStoreInstance ssInstance)
Constructs a RemoveSecretStore command bean and sets the SecretStoreInstance to be used.

Method Summary

void	execute() Executes this command bean for removing a SecretStore.
SSFlags	getFlags() Returns the flags set.
boolean	isReady() Tests whether the required input properties are set and the bean is in "initialized" state.
void	reset() Resets the output properties to the values they had before the execute method was called.
void	setFlags(SSFlags flags) Sets the flags to be used while deleting the SecretStore.

Methods inherited from class com.novell.ecb.secretstore.SecretStoreBean

getSecretStoreInstance, setSecretStoreInstance

Methods inherited from class java.lang.Object

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

Constructor Detail

RemoveSecretStore

public RemoveSecretStore()

Constructs a RemoveSecretStore command bean.

RemoveSecretStore

public RemoveSecretStore(SecretStoreInstance ssInstance)

Constructs a RemoveSecretStore command bean and sets the SecretStoreInstance to be used.

Parameters:

ssInstance - A SecretStoreInstance object that represents the SecretStore to be removed.

Method Detail

setFlags

public void setFlags(SSFlags flags)

Sets the flags to be used while deleting the SecretStore.

Parameters:

flags - Flags for the operation. Currently, no flag is defined for this bean. Property is provided here for future use.

getFlags

public SSFlags getFlags()

Returns the flags set.

Returns:

SSFlags The flags set.

isReady

public boolean isReady()

Tests whether the required input properties are set and the bean is in "initialized" state.

If the user does not set a value for optional input property, default value is used. Therefore, these properties do not affect the readiness of the bean. However, bean will not be in ready state if any of the required input properties is not set.

Returns:

boolean True if the bean is in initialized state; else, returns False.

reset

public void reset()

Resets the output properties to the values they had before the execute method was called.

There is no output property to reset.

execute

public void execute()
             throws CommandException

Executes this command bean for removing a SecretStore.

Throws:

CommandException - Thrown if the bean fails to execute.

Example: Shows how to use RemoveSecretStore bean.

     // Get the SecretStoreInstance created by the CreateSecretStoreInstance bean.
   SecretStoreInstance ssi = createSSI.getSecretStoreInstance();
   try
     {
         // Instantiate the command bean
       RemoveSecretStore removeSS = new RemoveSecretStore(ssi);
         // This bean has SecretStoreInstance as the only
         // input property
         // Call the execute method of the command bean
       removeSS.execute();
         // There is no output property of this bean
         // Do any further operations
       ...
       ...
     }
     catch(CommandException e)
      {
         // TODO: Handle exception
      }
 

See Also:

CreateSecretStoreInstance