com.novell.ecb.secretstore
Class SSFlags

java.lang.Object
  |
  +--com.novell.ecb.secretstore.SSFlags

public class SSFlags

extends java.lang.Object

Convenience obeject provided for easy handling of flags for performing operations on the SecretStore.

This object defines two types of flags, input flags and output flags. Input flags start with IN_ prefix and output flags start with OUT_ prefix. Input flags are supposed to be passed in to the bean before executing a bean, and output flags are those flags which are returned by the server to reflect the Secret and SecretStore status. Therefore, output flags are returned only by getStatus() methods.

Version:

1.0

Field Summary

static int	IN_CHECK_ID_COLLISION Input only flag that specifies that before writing the value of a Secret SecretID collision must be checked.
static int	IN_CREATE_ID Deprecated. Use IN_CHECK_ID_COLLISION flag.
static int	IN_REMOVE_LOCK_FROM_STORE Input only flag to specify that all locked secrets are to be deleted.
static int	OUT_ENHANCED_PROTECTED Output only flag to indicate that the secret is enhanced protected.
static int	OUT_EP_PWORD_PRESENT Output only flag that specifies that the secret is protected with an enhanced protection password.
static int	OUT_LAST_MOD_BY_ADMIN Output only flag that specifies that the last secret modification was made by an administrator.
static int	OUT_MASTER_PWORD_PRESENT Output only flag that specifies that a master password is set on the SecretStore.
static int	OUT_MP_NOT_ALLOWED Output only flag that specifies that master password operations have been disabled by policy.
static int	OUT_SECRET_LOCKED Output only flag that specifies that a lock exists.
static int	OUT_SECRET_NOT_INITIALIZED Output only flag that specifies that the secret has not been initialized with a write yet.
static int	OUT_STORE_NOT_SYNCED Output only flag that specifies that the SecretStore is not synchronized across replicas.
static int	OUT_UNLOCKED_BY_ADMIN Output only flag that specifies that an administrator has unlocked SecretStore.

Constructor Summary

SSFlags(int flags)
Constructs an SSFlags object and sets the flags.

Method Summary

void	clearAll() Clears all the flags.
void	clearFlag(int flag) Clears the given flag.
int	getNumFlags() Returns the number of flags set in the object.
boolean	isSet(int flag) Checks whether the given flag is set or not.
void	setFlag(int flag) Sets the given flag.

Methods inherited from class java.lang.Object

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

Field Detail

IN_REMOVE_LOCK_FROM_STORE

public static final int IN_REMOVE_LOCK_FROM_STORE

Input only flag to specify that all locked secrets are to be deleted. This operation in effect removes the lock that was placed on the SecretStore.

See Also:

Constant Field Values

IN_CREATE_ID

public static final int IN_CREATE_ID

Deprecated. Use IN_CHECK_ID_COLLISION flag.

Input only flag that specifies that create and write operations be performed together. In other words, the use of this flag disables name collision checking.

See Also:

Constant Field Values

IN_CHECK_ID_COLLISION

public static final int IN_CHECK_ID_COLLISION

Input only flag that specifies that before writing the value of a Secret SecretID collision must be checked. In other words, the use of this flag enables ID collision checking.

See Also:

Constant Field Values

OUT_ENHANCED_PROTECTED

public static final int OUT_ENHANCED_PROTECTED

Output only flag to indicate that the secret is enhanced protected.

See Also:

Constant Field Values

OUT_MASTER_PWORD_PRESENT

public static final int OUT_MASTER_PWORD_PRESENT

Output only flag that specifies that a master password is set on the SecretStore.

See Also:

Constant Field Values

OUT_EP_PWORD_PRESENT

public static final int OUT_EP_PWORD_PRESENT

Output only flag that specifies that the secret is protected with an enhanced protection password.

See Also:

Constant Field Values

OUT_LAST_MOD_BY_ADMIN

public static final int OUT_LAST_MOD_BY_ADMIN

Output only flag that specifies that the last secret modification was made by an administrator.

See Also:

Constant Field Values

OUT_UNLOCKED_BY_ADMIN

public static final int OUT_UNLOCKED_BY_ADMIN

Output only flag that specifies that an administrator has unlocked SecretStore.

See Also:

Constant Field Values

OUT_MP_NOT_ALLOWED

public static final int OUT_MP_NOT_ALLOWED

Output only flag that specifies that master password operations have been disabled by policy.

See Also:

Constant Field Values

OUT_SECRET_LOCKED

public static final int OUT_SECRET_LOCKED

Output only flag that specifies that a lock exists.

See Also:

Constant Field Values

OUT_SECRET_NOT_INITIALIZED

public static final int OUT_SECRET_NOT_INITIALIZED

Output only flag that specifies that the secret has not been initialized with a write yet.

See Also:

Constant Field Values

OUT_STORE_NOT_SYNCED

public static final int OUT_STORE_NOT_SYNCED

Output only flag that specifies that the SecretStore is not synchronized across replicas.

See Also:

Constant Field Values

Constructor Detail

SSFlags

public SSFlags(int flags)

Constructs an SSFlags object and sets the flags.

Method Detail

setFlag

public void setFlag(int flag)

Sets the given flag.

Parameters:

flag - The flag to be set.

clearFlag

public void clearFlag(int flag)

Clears the given flag.

Parameters:

flag - The flag to be cleared.

clearAll

public void clearAll()

Clears all the flags.

isSet

public boolean isSet(int flag)

Checks whether the given flag is set or not.

Returns:

boolean True if the flag is set; else, returns False.

getNumFlags

public int getNumFlags()

Returns the number of flags set in the object.

Returns:

int The number of flags set in the object.