net.cnri.apps.doserver.operators

Class LuceneIndexer

java.lang.Object

net.cnri.knowbots.lib.Knowbot

net.cnri.apps.doserver.operators.LuceneIndexer

All Implemented Interfaces:

java.io.Serializable, java.lang.Runnable, DOConstants, DOOperation

public class LuceneIndexer
extends net.cnri.knowbots.lib.Knowbot
implements DOOperation, java.lang.Runnable, DOConstants

Operator that provides text indexing capabilities using the Lucene search engine. This version analyzes the transaction log from a particular repository and indexes any objects in that repository.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	FEDERATED_INDEXES_KEY
static java.lang.String	INDEX_BUILDER_CLASS_KEY
static java.lang.String	INSECURE_SEARCH_KEY
static java.lang.String	LUCENE_CONFIG_ELEMENT
static int	MAX_DOCS
static java.lang.String	PARAM_ACTUAL_TIMESTAMP
static java.lang.String	PARAM_ELEMENT_ID
static java.lang.String	PARAM_OBJ_ID
static java.lang.String	PARAM_TIMESTAMP
static java.lang.String	PARAM_TXN_ID
static java.lang.String	PARAM_TXN_TYPE
static java.lang.String	TXN_TYPE_ADD_OBJ
static java.lang.String	TXN_TYPE_COMMENT
static java.lang.String	TXN_TYPE_DEL_ELEMENT
static java.lang.String	TXN_TYPE_DEL_OBJ
static java.lang.String	TXN_TYPE_UPDATE_ELEMENT

Fields inherited from interface net.cnri.dobj.DOConstants

ABSTRACT_ATTRIBUTE, ADD_RELATIONSHIPS_OP_ID, ADD_TYPE_OP_ID, ANONYMOUS_ID, AUDIT_GET_OP_ID, AUDIT_QUERY_OP_ID, CHECK_AUTHORIZATION_OP_ID, CHECK_DELEGATE_OP_ID, CLIENT_AUTH_TYPE_HSPUBKEY, CLIENT_AUTH_TYPE_HSSECKEY, CONTENT_ELEMENT_ID, CREATE_OBJ_OP_ID, CREATOR_ATTRIBUTE, DATE_CREATED_ATTRIBUTE, DATE_FORMAT_MDYHMS, DATE_MODIFIED_ATTRIBUTE, DEFAULT_CLIENT_CERT_EXPIRATION_DAYS, DEL_ATTRIBUTES_OP_ID, DELETE_DATA_OP_ID, DELETE_OBJ_OP_ID, DOES_OBJ_EXIST_OP_ID, ELEMENT_ATTS_MSGTYPE, EM_COMMAND_CREATE_DATASTREAM, EM_COMMAND_CREATE_DISSEMINATOR, EM_COMMAND_CREATE_DO, EM_COMMAND_DELETE_ATTACHMENTS, EM_COMMAND_DELETE_DATASTREAM, EM_COMMAND_DELETE_DISSEMINATOR, EM_COMMAND_DELETE_DO, EM_COMMAND_GET_DATASTREAM_BYTES, EM_COMMAND_GET_DATASTREAM_KEY_METADATA, EM_COMMAND_GET_DISSEMINATION, EM_COMMAND_GET_DISSEMINATOR_METADATA, EM_COMMAND_GET_EXECUTABLE, EM_COMMAND_GET_KEY_METADATA, EM_COMMAND_GET_READ_REQUEST, EM_COMMAND_GET_SERVLET, EM_COMMAND_GET_TYPE_SIGNATURE, EM_COMMAND_GET_VERSION, EM_COMMAND_LIST_ATTACHMENTS, EM_COMMAND_LIST_DATASTREAMS, EM_COMMAND_LIST_DISSEMINATORS, EM_COMMAND_LIST_DO, EM_COMMAND_LIST_DO_POLICIES, EM_COMMAND_SET_ATTACHMENTS, EM_COMMAND_SET_DATASTREAM_BYTES, EM_COMMAND_SET_DO_POLICIES, EM_COMMAND_SET_EXECUTABLE, EM_COMMAND_SET_READ_REQUEST, EM_COMMAND_VERIFY_DO, FILE_NAME_ATTRIBUTE, FOLDER_ATTRIBUTE, GET_ATTRIBUTES_OP_ID, GET_CREDENTIALS_OP_ID, GET_DATA_OP_ID, GET_REPO_TXNS_OP_ID, GET_SERIALIZED_FORM_OP_ID, GRANT_KEY_OP_ID, HAS_TYPE_OP_ID, INDEX_UP_TO_DATE_ID, INJECT_KNOWBOT_OP_ID, IS_PART_OF_ATTRIBUTE, LANGUAGE_ATTRIBUTE, LIST_DATA_OP_ID, LIST_DELEGATORS_OP_ID, LIST_OBJECTS_OP_ID, LIST_OPERATIONS_OP_ID, LIST_TYPES_OP_ID, MIME_TYPE_ATTRIBUTE, NOTES_ATTRIBUTE, OBJECT_ATTS_MSGTYPE, OBJECT_NAME_HDL_TYPE, OBJECT_SERVER_HDL_TYPE, OBJECT_SVRINFO_HDL_TYPE, OWNER_ATTRIBUTE, PARAM_ATTRIBUTES, PUSH_REPO_TXN_OP_ID, REFERENCES_ATTRIBUTE, REINDEX_OBJECT_ID, REMOVE_TYPE_OP_ID, REPO_RIGHTS_ELEMENT_ID, RIGHTS_DELEGATION_OBJECT_HDL_TYPE, RIGHTS_ELEMENT_ID, SEARCH_OP_ID, SET_ATTRIBUTES_OP_ID, SIZE_ATTRIBUTE, STORE_CREDENTIAL_OP_ID, STORE_DATA_OP_ID, TITLE_ATTRIBUTE

Constructor Summary

Constructors

Constructor and Description
LuceneIndexer(Main serverMain)

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canHandleOperation(DOOperationContext context) Returns true iff this object can perform the given operation on behalf of the caller on the given object.
void	executeInContext()
java.lang.String[]	listOperations(DOOperationContext context) Returns a list of operations that this operator can perform on the object identified by the DOOperationContext parameter.
void	performOperation(DOOperationContext context, java.io.InputStream in, java.io.OutputStream out) Performs the given operation (which this object has advertised that it can handle) which consists of reading input (if any is expected) from the given InputStream and writing the output of the operation (if any) to the OutputStream.
void	reindexObject(java.lang.String objectId)
void	run()
void	shutdown()

Methods inherited from class net.cnri.knowbots.lib.Knowbot

getContext, getIconImage, getLabel, initializeInContext, setContext

Methods inherited from class java.lang.Object

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

Field Detail

INDEX_BUILDER_CLASS_KEY

public static final java.lang.String INDEX_BUILDER_CLASS_KEY

See Also:

Constant Field Values

INSECURE_SEARCH_KEY

public static final java.lang.String INSECURE_SEARCH_KEY

See Also:

Constant Field Values

MAX_DOCS

public static final int MAX_DOCS

See Also:

Constant Field Values

LUCENE_CONFIG_ELEMENT

public static final java.lang.String LUCENE_CONFIG_ELEMENT

See Also:

Constant Field Values

FEDERATED_INDEXES_KEY

public static final java.lang.String FEDERATED_INDEXES_KEY

See Also:

Constant Field Values

PARAM_TXN_ID

public static final java.lang.String PARAM_TXN_ID

See Also:

Constant Field Values

PARAM_OBJ_ID

public static final java.lang.String PARAM_OBJ_ID

See Also:

Constant Field Values

PARAM_TXN_TYPE

public static final java.lang.String PARAM_TXN_TYPE

See Also:

Constant Field Values

PARAM_TIMESTAMP

public static final java.lang.String PARAM_TIMESTAMP

See Also:

Constant Field Values

PARAM_ACTUAL_TIMESTAMP

public static final java.lang.String PARAM_ACTUAL_TIMESTAMP

See Also:

Constant Field Values

PARAM_ELEMENT_ID

public static final java.lang.String PARAM_ELEMENT_ID

See Also:

Constant Field Values

TXN_TYPE_ADD_OBJ

public static final java.lang.String TXN_TYPE_ADD_OBJ

See Also:

Constant Field Values

TXN_TYPE_DEL_OBJ

public static final java.lang.String TXN_TYPE_DEL_OBJ

See Also:

Constant Field Values

TXN_TYPE_UPDATE_ELEMENT

public static final java.lang.String TXN_TYPE_UPDATE_ELEMENT

See Also:

Constant Field Values

TXN_TYPE_DEL_ELEMENT

public static final java.lang.String TXN_TYPE_DEL_ELEMENT

See Also:

Constant Field Values

TXN_TYPE_COMMENT

public static final java.lang.String TXN_TYPE_COMMENT

See Also:

Constant Field Values

Constructor Detail

LuceneIndexer

public LuceneIndexer(Main serverMain)
              throws java.lang.Exception

Throws:

java.lang.Exception

Method Detail

executeInContext

public void executeInContext()

Specified by:

executeInContext in class net.cnri.knowbots.lib.Knowbot

canHandleOperation

public boolean canHandleOperation(DOOperationContext context)

Description copied from interface: DOOperation

Returns true iff this object can perform the given operation on behalf of the caller on the given object. The operation, object, caller, and request parameters are all provided by the given DOOperationContext object.

Specified by:

canHandleOperation in interface DOOperation

listOperations

public java.lang.String[] listOperations(DOOperationContext context)

Returns a list of operations that this operator can perform on the object identified by the DOOperationContext parameter.

Specified by:

listOperations in interface DOOperation

run

public void run()

Specified by:

run in interface java.lang.Runnable

shutdown

public void shutdown()

performOperation

public void performOperation(DOOperationContext context,
                    java.io.InputStream in,
                    java.io.OutputStream out)

Performs the given operation (which this object has advertised that it can handle) which consists of reading input (if any is expected) from the given InputStream and writing the output of the operation (if any) to the OutputStream. This method should *always* close the input and output streams when finished with them. If there are any errors in the input, the error message must be communicated on the OutputStream since all errors must be at the application level. Any exceptions thrown by this method will *not* be communicated to the caller and are therefore not acceptable.

Specified by:

performOperation in interface DOOperation

reindexObject

public void reindexObject(java.lang.String objectId)
                   throws java.lang.Exception

Throws:

java.lang.Exception