org.openptk.spi.operations
Interface OperationsIF

All Superinterfaces:
java.lang.Comparable<org.openptk.common.ComponentIF>, org.openptk.common.ComponentIF
All Known Implementing Classes:
LoopbackOperations, Operations

public interface OperationsIF
extends org.openptk.common.ComponentIF

Author:
Scott Fehrman, Sun Microsystems Inc,

Field Summary
static java.lang.String PROP_ATTRIBUTE_EMPTY_REMOVE
           
static java.lang.String PROP_DRIVER
           
static java.lang.String PROP_FILENAME
           
static java.lang.String PROP_PROTOCOL
           
static java.lang.String PROP_PROXY_HOST
           
static java.lang.String PROP_PROXY_PORT
           
static java.lang.String PROP_RESET_PASSWORD_LENGTH
           
static java.lang.String PROP_URL
           
static java.lang.String PROP_USER_NAME
           
static java.lang.String PROP_USER_NAME_ENCRYPTED
           
static java.lang.String PROP_USER_PASSWORD
           
static java.lang.String 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
 
Method Summary
 void execute(org.openptk.common.RequestIF req, org.openptk.common.ResponseIF res)
           
 ServiceIF getService()
           
 OperationsType getType()
           
 java.lang.String getTypeAsString()
           
 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)
           
 void setService(ServiceIF service)
           
 void setType(OperationsType type)
           
 void shutdown()
           
 void startup()
           
 
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

PROP_ATTRIBUTE_EMPTY_REMOVE

static final java.lang.String PROP_ATTRIBUTE_EMPTY_REMOVE
See Also:
Constant Field Values

PROP_DRIVER

static final java.lang.String PROP_DRIVER
See Also:
Constant Field Values

PROP_FILENAME

static final java.lang.String PROP_FILENAME
See Also:
Constant Field Values

PROP_PROTOCOL

static final java.lang.String PROP_PROTOCOL
See Also:
Constant Field Values

PROP_PROXY_HOST

static final java.lang.String PROP_PROXY_HOST
See Also:
Constant Field Values

PROP_PROXY_PORT

static final java.lang.String PROP_PROXY_PORT
See Also:
Constant Field Values

PROP_RESET_PASSWORD_LENGTH

static final java.lang.String PROP_RESET_PASSWORD_LENGTH
See Also:
Constant Field Values

PROP_URL

static final java.lang.String PROP_URL
See Also:
Constant Field Values

PROP_USER_NAME

static final java.lang.String PROP_USER_NAME
See Also:
Constant Field Values

PROP_USER_NAME_ENCRYPTED

static final java.lang.String PROP_USER_NAME_ENCRYPTED
See Also:
Constant Field Values

PROP_USER_PASSWORD

static final java.lang.String PROP_USER_PASSWORD
See Also:
Constant Field Values

PROP_USER_PASSWORD_ENCRYPTED

static final java.lang.String PROP_USER_PASSWORD_ENCRYPTED
See Also:
Constant Field Values
Method Detail

execute

void execute(org.openptk.common.RequestIF req,
             org.openptk.common.ResponseIF res)
             throws OperationException
Parameters:
req -
res -
Throws:
OperationException

getService

ServiceIF getService()
Returns:
ServiceIF

getType

OperationsType getType()
Returns:
OperationsType

getTypeAsString

java.lang.String getTypeAsString()
Returns:
String

isEnabled

boolean isEnabled(org.openptk.common.Operation operation)
Parameters:
operation -
Returns:
boolean

isImplemented

boolean isImplemented(org.openptk.common.Operation operation)
Parameters:
operation -
Returns:
boolean

postExecute

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

preExecute

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

setEnabled

void setEnabled(org.openptk.common.Operation operation,
                boolean enabled)
Parameters:
operation -
enabled -

setService

void setService(ServiceIF service)
Parameters:
service -

setType

void setType(OperationsType type)
Parameters:
type -

shutdown

void shutdown()

startup

void startup()


View/submit a bug or feature

For further API reference and developer documentation, see www.openptk.org. That documentation contains more detailed, developer-targeted descriptions, definitions of terms, workarounds, and working code examples.

Copyright (C) 2008-2012, Project OpenPTK. All Rights Reserved