org.openptk.spi.operations
Class Operations

java.lang.Object
  org.openptk.common.Component
      org.openptk.spi.operations.Operations

All Implemented Interfaces:

java.lang.Comparable<org.openptk.common.ComponentIF>, org.openptk.common.ComponentIF, OperationsIF

Direct Known Subclasses:

LoopbackOperations

public abstract class Operations
extends org.openptk.common.Component
implements OperationsIF

Author:

Scott Fehrman, Sun Microsystems, Inc. contributor Derrick Harcey, Sun Microsystems, Inc.

Field Summary

protected boolean	_emptyRemove
protected static java.lang.String	RESPONSE_DESC
protected static int	TRANS_FW_SRVC
protected static int	TRANS_SRVC_FW

Fields inherited from interface org.openptk.spi.operations.OperationsIF

PROP_ATTRIBUTE_EMPTY_REMOVE, PROP_DRIVER, PROP_FILENAME, PROP_PROTOCOL, PROP_PROXY_HOST, PROP_PROXY_PORT, PROP_RESET_PASSWORD_LENGTH, PROP_URL, PROP_USER_NAME, PROP_USER_NAME_ENCRYPTED, PROP_USER_PASSWORD, PROP_USER_PASSWORD_ENCRYPTED

Fields inherited from interface org.openptk.common.ComponentIF

EXECUTE_BEGIN, EXECUTE_END, PROP_OPENPTK_HOME, PROP_OPENPTK_TEMP, SORT_BEGIN, SORT_END

Constructor Summary

Operations()

Method Summary

protected void	checkException(java.lang.Exception ex, java.lang.StringBuilder buf)
protected void	checkPasswordAttribute(org.openptk.common.RequestIF request)
protected void	doPasswordForgot(org.openptk.common.RequestIF request, org.openptk.common.ResponseIF response)
abstract void	execute(org.openptk.common.RequestIF req, org.openptk.common.ResponseIF res)
protected java.lang.String	findProperty(org.openptk.common.RequestIF request, java.lang.String propName)
protected java.lang.String[]	getArrayFromList(java.util.List<java.lang.String> list)
protected java.lang.String[]	getAttrValueAsStringArray(org.openptk.common.AttrIF attr)
protected java.lang.String	getCheckProp(java.lang.String propName)
protected void	getPasswordAttribute(org.openptk.common.RequestIF request)
protected void	getPasswordResult(org.openptk.common.ResponseIF response)
ServiceIF	getService()
protected java.lang.String[]	getServiceNames(org.openptk.common.RequestIF request)
OperationsType	getType()
java.lang.String	getTypeAsString()
protected java.lang.Object	getUniqueIdValueFromRequest(org.openptk.common.RequestIF request)
protected java.lang.String	getValue(java.lang.String key)
protected void	handleError(java.lang.String msg)
boolean	isEnabled(org.openptk.common.Operation operation)
boolean	isImplemented(org.openptk.common.Operation operation)
void	postExecute(org.openptk.common.RequestIF req, org.openptk.common.ResponseIF res)
void	preExecute(org.openptk.common.RequestIF req, org.openptk.common.ResponseIF res)
void	setEnabled(org.openptk.common.Operation operation, boolean enabled)
protected void	setImplemented(org.openptk.common.Operation operation, boolean implemented)
void	setService(ServiceIF service)
void	setType(OperationsType type)
void	shutdown()
void	startup()
protected void	updateQueryServiceName(Query query)

Methods inherited from class org.openptk.common.Component

compareTo, copy, getAttribute, getAttributes, getAttributesNames, getAttributesSize, getCategory, getCategoryAsString, getDebugLevel, getDebugLevelAsInt, getDebugLevelAsString, getDescription, getProperties, getPropertiesSize, getProperty, getSortValue, getState, getStateAsString, getStatus, getTimeStamp, getTimeStampNames, getTimeStamps, getUniqueId, getUniqueIdType, isDebug, isError, isTimeStamp, setAttribute, setAttributes, setCategory, setDebug, setDebugLevel, setDescription, setError, setProperties, setProperty, setSortValue, setState, setState, setStatus, setTimeStamp, setTimeStamp, setUniqueId, setUniqueId, setUniqueId, setUniqueId, toString, useTimeStamp

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.openptk.common.ComponentIF

copy, getAttribute, getAttributes, getAttributesNames, getAttributesSize, getCategory, getCategoryAsString, getDebugLevel, getDebugLevelAsInt, getDebugLevelAsString, getDescription, getProperties, getPropertiesSize, getProperty, getSortValue, getState, getStateAsString, getStatus, getTimeStamp, getTimeStampNames, getTimeStamps, getUniqueId, getUniqueIdType, isDebug, isError, isTimeStamp, setAttribute, setAttributes, setCategory, setDebug, setDebugLevel, setDescription, setError, setProperties, setProperty, setSortValue, setState, setState, setStatus, setTimeStamp, setTimeStamp, setUniqueId, setUniqueId, setUniqueId, setUniqueId, useTimeStamp

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

_emptyRemove

protected boolean _emptyRemove

RESPONSE_DESC

protected static java.lang.String RESPONSE_DESC

TRANS_FW_SRVC

protected static final int TRANS_FW_SRVC

See Also:

Constant Field Values

TRANS_SRVC_FW

protected static final int TRANS_SRVC_FW

See Also:

Constant Field Values

Constructor Detail

Operations

public Operations()

Method Detail

checkException

protected void checkException(java.lang.Exception ex,
                              java.lang.StringBuilder buf)

checkPasswordAttribute

protected void checkPasswordAttribute(org.openptk.common.RequestIF request)
                               throws OperationException

Parameters:

request -

Throws:

OperationException

doPasswordForgot

protected void doPasswordForgot(org.openptk.common.RequestIF request,
                                org.openptk.common.ResponseIF response)
                         throws OperationException

Parameters:

request -

response -

Throws:

OperationException

execute

public abstract void execute(org.openptk.common.RequestIF req,
                             org.openptk.common.ResponseIF res)
                      throws OperationException

Specified by:

execute in interface OperationsIF

Parameters:

req -

res -

Throws:

OperationException

findProperty

protected java.lang.String findProperty(org.openptk.common.RequestIF request,
                                        java.lang.String propName)

Parameters:

request -

propName -

Returns:

String

getArrayFromList

protected java.lang.String[] getArrayFromList(java.util.List<java.lang.String> list)

Parameters:

list -

Returns:

String[]

getAttrValueAsStringArray

protected java.lang.String[] getAttrValueAsStringArray(org.openptk.common.AttrIF attr)

Parameters:

attr -

Returns:

String[]

getCheckProp

protected java.lang.String getCheckProp(java.lang.String propName)
                                 throws OperationException

Throws:

OperationException

getPasswordAttribute

protected void getPasswordAttribute(org.openptk.common.RequestIF request)
                             throws OperationException

Parameters:

request -

Throws:

OperationException

getPasswordResult

protected void getPasswordResult(org.openptk.common.ResponseIF response)
                          throws OperationException

Parameters:

response -

Throws:

OperationException

getService

public final ServiceIF getService()

Specified by:

getService in interface OperationsIF

Returns:

ServiceIF

getServiceNames

protected java.lang.String[] getServiceNames(org.openptk.common.RequestIF request)

Parameters:

request -

Returns:

String[]

getType

public final OperationsType getType()

Specified by:

getType in interface OperationsIF

Returns:

OperationsType

getTypeAsString

public final java.lang.String getTypeAsString()

Specified by:

getTypeAsString in interface OperationsIF

Returns:

String

getUniqueIdValueFromRequest

protected final java.lang.Object getUniqueIdValueFromRequest(org.openptk.common.RequestIF request)
                                                      throws OperationException

Throws:

OperationException

getValue

protected java.lang.String getValue(java.lang.String key)

Parameters:

key -

Returns:

String

handleError

protected void handleError(java.lang.String msg)
                    throws OperationException

Parameters:

msg -

Throws:

OperationException

isEnabled

public final boolean isEnabled(org.openptk.common.Operation operation)

Specified by:

isEnabled in interface OperationsIF

Parameters:

operation -

Returns:

boolean

isImplemented

public final boolean isImplemented(org.openptk.common.Operation operation)

Specified by:

isImplemented in interface OperationsIF

Parameters:

operation -

Returns:

boolean

postExecute

public void postExecute(org.openptk.common.RequestIF req,
                        org.openptk.common.ResponseIF res)
                 throws OperationException

Specified by:

postExecute in interface OperationsIF

Parameters:

req -

res -

Throws:

OperationException

preExecute

public void preExecute(org.openptk.common.RequestIF req,
                       org.openptk.common.ResponseIF res)
                throws OperationException

Specified by:

preExecute in interface OperationsIF

Parameters:

req -

res -

Throws:

OperationException

setEnabled

public final void setEnabled(org.openptk.common.Operation operation,
                             boolean enabled)

Specified by:

setEnabled in interface OperationsIF

Parameters:

operation -

enabled -

setImplemented

protected void setImplemented(org.openptk.common.Operation operation,
                              boolean implemented)

Parameters:

operation -

implemented -

setService

public final void setService(ServiceIF service)

Specified by:

setService in interface OperationsIF

Parameters:

service -

setType

public final void setType(OperationsType type)

Specified by:

setType in interface OperationsIF

Parameters:

type -

shutdown

public void shutdown()

Specified by:

shutdown in interface OperationsIF

startup

public void startup()

Specified by:

startup in interface OperationsIF

updateQueryServiceName

protected void updateQueryServiceName(Query query)

Parameters:

query -