de.innovationgate.webgate.api

Class WGOperationKey

java.lang.Object

de.innovationgate.webgate.api.WGOperationKey

public class WGOperationKey
extends java.lang.Object

An key for an operation involving the backend database. This key is used to synchronize similar backend database accesses and avoid parallel execution. The key represents a special backend operation, e.g. read structentry "xyz". The backend operation is synchronized on this key object. So if another thread tries to fetch structentry "xyz" while a first thread retrieves it from the backend, it is forced to wait for the first thread to finish. Then, it will not retrieve the struct from the backend but from the cache that was filled by the first thread. Once a document is in cache there is no more synchronizing going on. All threads have unsynchronized access to the document cache.

Field Summary

Fields

Modifier and Type	Field and Description
static int	OP_CONTENT_BY_NAME Operation type: Retrieve a content by it's unique name
static int	OP_DELETE Operation type: Delete a document
static int	OP_DESIGN_BACKEND Operation type: Backend access for design provider
static int	OP_DESIGN_LIST Operation type: Retrieve the list of designs of a specific type
static int	OP_DOCUMENT_BY_KEY Operation type: Retrieve a content by contentkey
static int	OP_DOCUMENT_CORE Operation type: Retrieve a document core (Not used as sync key, just for verbose backend access logging)
static int	OP_DOCUMENT_CORE_FASTACCESS Operation type: Retrieve a document core in fast access (Not used as sync key, just for verbose backend access logging)
static int	OP_HDB_CREATE_STORAGE Operation type: HDB getCreateStorage
static int	OP_HDB_GET_OR_CREATE_STORAGE Operation type: HDB getOrCreateStorage
static int	OP_QUERY Operation type: Native query to database backend (Not used as sync key, just for verbose backend access logging)
static int	OP_QUERY_HAS_RESULTS Operation type: Checking for result availability of a query
static int	OP_QUERY_RESULT_COUNT Operation type: Retrieve the result count of a query
static int	OP_SAVE Operation type: Save a document
static int	OP_STRUCT_BY_NAME Operation type: Retrieve a struct entry by it's unique name
static int	OP_STRUCT_CHILDREN Operation type: Retrieve the children of a struct entry
static int	OP_STRUCT_CONTENTS Operation type: Retrieve the contents of a struct entry
static int	OP_STRUCT_CONTENTS_INCLUDING_ARCHIVED Operation type: Retrieve the contents of a struct entry
static int	OP_STRUCT_PARENT Operation type: Retrieve a design document
static int	OP_STRUCT_ROOTS Operation type: Retrieve the root entries of an area

Constructor Summary

Constructors

Constructor and Description
WGOperationKey(WGDatabase db, int operation, java.lang.String key) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
static java.lang.String	createString(int operation, java.lang.String key) Create an operation key string.
boolean	equals(java.lang.Object arg0)
java.lang.String	getKey() Returns the detail key for this operation, i.e. the special key of the document that should get fetched.
int	getOperation() The operation type.
static java.lang.String	getOperationName(int op) Returns a descriptive name for an operation code
int	hashCode()
boolean	isUsed() Returns if the operation key is currently in use
void	setUsed(boolean used) Sets the usage state of the operation key
java.lang.String	toString() Returns the operation key string for this operation.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

OP_DOCUMENT_BY_KEY

public static final int OP_DOCUMENT_BY_KEY

Operation type: Retrieve a content by contentkey

See Also:

Constant Field Values

OP_CONTENT_BY_NAME

public static final int OP_CONTENT_BY_NAME

Operation type: Retrieve a content by it's unique name

See Also:

Constant Field Values

OP_STRUCT_PARENT

public static final int OP_STRUCT_PARENT

Operation type: Retrieve a design document

See Also:

Constant Field Values

OP_STRUCT_CHILDREN

public static final int OP_STRUCT_CHILDREN

Operation type: Retrieve the children of a struct entry

See Also:

Constant Field Values

OP_STRUCT_ROOTS

public static final int OP_STRUCT_ROOTS

Operation type: Retrieve the root entries of an area

See Also:

Constant Field Values

OP_STRUCT_CONTENTS

public static final int OP_STRUCT_CONTENTS

Operation type: Retrieve the contents of a struct entry

See Also:

Constant Field Values

OP_DESIGN_LIST

public static final int OP_DESIGN_LIST

Operation type: Retrieve the list of designs of a specific type

See Also:

Constant Field Values

OP_DOCUMENT_CORE

public static final int OP_DOCUMENT_CORE

Operation type: Retrieve a document core (Not used as sync key, just for verbose backend access logging)

See Also:

Constant Field Values

OP_DOCUMENT_CORE_FASTACCESS

public static final int OP_DOCUMENT_CORE_FASTACCESS

Operation type: Retrieve a document core in fast access (Not used as sync key, just for verbose backend access logging)

See Also:

Constant Field Values

OP_QUERY

public static final int OP_QUERY

Operation type: Native query to database backend (Not used as sync key, just for verbose backend access logging)

See Also:

Constant Field Values

OP_HDB_CREATE_STORAGE

public static final int OP_HDB_CREATE_STORAGE

Operation type: HDB getCreateStorage

See Also:

Constant Field Values

OP_HDB_GET_OR_CREATE_STORAGE

public static final int OP_HDB_GET_OR_CREATE_STORAGE

Operation type: HDB getOrCreateStorage

See Also:

Constant Field Values

OP_STRUCT_CONTENTS_INCLUDING_ARCHIVED

public static final int OP_STRUCT_CONTENTS_INCLUDING_ARCHIVED

Operation type: Retrieve the contents of a struct entry

See Also:

Constant Field Values

OP_SAVE

public static final int OP_SAVE

Operation type: Save a document

See Also:

Constant Field Values

OP_DELETE

public static final int OP_DELETE

Operation type: Delete a document

See Also:

Constant Field Values

OP_QUERY_RESULT_COUNT

public static final int OP_QUERY_RESULT_COUNT

Operation type: Retrieve the result count of a query

See Also:

Constant Field Values

OP_QUERY_HAS_RESULTS

public static final int OP_QUERY_HAS_RESULTS

Operation type: Checking for result availability of a query

See Also:

Constant Field Values

OP_STRUCT_BY_NAME

public static final int OP_STRUCT_BY_NAME

Operation type: Retrieve a struct entry by it's unique name

See Also:

Constant Field Values

OP_DESIGN_BACKEND

public static final int OP_DESIGN_BACKEND

Operation type: Backend access for design provider

See Also:

Constant Field Values

Constructor Detail

WGOperationKey

public WGOperationKey(WGDatabase db,
              int operation,
              java.lang.String key)

Constructor. Taking operation type and detail key.

Parameters:

operation - The operation for this key. Use constants WGOperationKey.OP_...

key - The detail key. This is the key of the document to be fetched, e.g. for Operation OP_CONTENT_BY_KEY the content key

Method Detail

isUsed

public boolean isUsed()

Returns if the operation key is currently in use

setUsed

public void setUsed(boolean used)
             throws WGIllegalStateException

Sets the usage state of the operation key

Throws:

WGIllegalStateException

getOperationName

public static java.lang.String getOperationName(int op)

Returns a descriptive name for an operation code

Parameters:

op - The operation code

getKey

public java.lang.String getKey()

Returns the detail key for this operation, i.e. the special key of the document that should get fetched.

getOperation

public int getOperation()

The operation type. Uses Constants WGOperationkey.OP_....

equals

public boolean equals(java.lang.Object arg0)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Returns the operation key string for this operation.

Overrides:

toString in class java.lang.Object

createString

public static java.lang.String createString(int operation,
                            java.lang.String key)

Create an operation key string. This one is used to determine equality between operation keys, especially when putting them to a hash map

Parameters:

operation -

key -