Overview  Package   Class  Tree  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.openptk.spi
Interface ServiceIF

All Superinterfaces:
java.lang.Comparable<org.openptk.common.ComponentIF>, org.openptk.common.ComponentIF
All Known Implementing Classes:
BasicService, RestartService, Service
public interface ServiceIF
extends org.openptk.common.ComponentIF

Field Summary
static java.lang.String PROP_URL
           
 
Fields inherited from interface org.openptk.common.ComponentIF
EXECUTE_BEGIN, EXECUTE_END, PROP_OPENPTK_HOME, PROP_OPENPTK_TEMP, SORT_BEGIN, SORT_END
 
Method Summary
 org.openptk.common.ResponseIF execute(org.openptk.common.RequestIF request)
           
 org.openptk.common.ComponentIF getAssociation(org.openptk.common.Operation operation)
           
 org.openptk.common.ComponentIF getAttrGroup(org.openptk.common.Operation operation)
           
 org.openptk.context.ContextIF getContext()
           
 java.util.Map<java.lang.String,java.lang.String> getFw2SrvcNames(org.openptk.common.Operation operation)
           
 java.lang.String getFwName(org.openptk.common.Operation operation, java.lang.String name)
           
 java.lang.String getKey(org.openptk.common.Operation operation)
           
 OperationsIF getOperation(org.openptk.common.Operation operation)
           
 java.util.Map<org.openptk.common.Operation,OperationsIF> getOperations()
           
 org.openptk.common.ComponentIF getOperAttr(org.openptk.common.Operation operation)
           
 java.util.Properties getOperProps(org.openptk.common.Operation operation)
           
 Query getQuery(org.openptk.common.Operation operation)
           
 java.util.List<java.lang.String> getSortAttributes()
           
 java.util.Map<java.lang.String,java.lang.String> getSrvc2FwNames(org.openptk.common.Operation operation)
           
 java.lang.String getSrvcName(org.openptk.common.Operation operation, java.lang.String name)
           
 int getTimeout(org.openptk.common.Operation operation)
           
 boolean hasOperation(org.openptk.common.Operation operation)
           
 boolean hasOperation(java.lang.String opstr)
           
 void setAssociation(org.openptk.common.Operation operation, org.openptk.common.ComponentIF comp)
           
 void setAttrGroup(org.openptk.common.Operation operation, org.openptk.common.ComponentIF comp)
           
 void setContext(org.openptk.context.ContextIF context)
           
 void setFw2SrvcNames(org.openptk.common.Operation operation, java.util.Map<java.lang.String,java.lang.String> map)
           
 void setKey(org.openptk.common.Operation operation, java.lang.String key)
           
 void setOperation(org.openptk.common.Operation oper, OperationsIF operation)
           
 void setOperAttr(org.openptk.common.Operation operation, org.openptk.common.ComponentIF comp)
           
 void setOperProps(org.openptk.common.Operation operation, java.util.Properties props)
           
 void setQuery(org.openptk.common.Operation operation, Query query)
           
 void setSortAttributes(java.util.List<java.lang.String> sortBy)
           
 void setSrvc2FwNames(org.openptk.common.Operation operation, java.util.Map<java.lang.String,java.lang.String> map)
           
 void setTimeout(org.openptk.common.Operation operation, int msec)
           
 void shutdown()
           
 void startup()
           
 java.lang.String[] toFw(org.openptk.common.Operation operation, java.lang.String[] fw)
           
 java.lang.String[] toSrvc(org.openptk.common.Operation operation, java.lang.String[] fw)
           
 
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_URL

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

execute

org.openptk.common.ResponseIF execute(org.openptk.common.RequestIF request)
                                      throws ServiceException
Parameters:
request -
Returns:
ResponseIF
Throws:
ServiceException

getAssociation

org.openptk.common.ComponentIF getAssociation(org.openptk.common.Operation operation)
Parameters:
operation -
Returns:
ComponentIF

getAttrGroup

org.openptk.common.ComponentIF getAttrGroup(org.openptk.common.Operation operation)
Parameters:
operation -
Returns:
ComponentIF

getContext

org.openptk.context.ContextIF getContext()
Returns:
ContextIF

getFw2SrvcNames

java.util.Map<java.lang.String,java.lang.String> getFw2SrvcNames(org.openptk.common.Operation operation)
Parameters:
operation -
Returns:
Map

getFwName

java.lang.String getFwName(org.openptk.common.Operation operation,
                           java.lang.String name)
Parameters:
operation -
name -
Returns:
String

getKey

java.lang.String getKey(org.openptk.common.Operation operation)
Parameters:
operation -
Returns:
String

getOperation

OperationsIF getOperation(org.openptk.common.Operation operation)
Parameters:
operation -
Returns:
OperationsIF

getOperations

java.util.Map<org.openptk.common.Operation,OperationsIF> getOperations()
Returns:
Map

getOperAttr

org.openptk.common.ComponentIF getOperAttr(org.openptk.common.Operation operation)
Parameters:
operation -
Returns:
ComponentIF

getOperProps

java.util.Properties getOperProps(org.openptk.common.Operation operation)
Parameters:
operation -
Returns:
Properties

getQuery

Query getQuery(org.openptk.common.Operation operation)
Parameters:
operation -
Returns:
Query

getSortAttributes

java.util.List<java.lang.String> getSortAttributes()
Returns:
List

getSrvc2FwNames

java.util.Map<java.lang.String,java.lang.String> getSrvc2FwNames(org.openptk.common.Operation operation)
Parameters:
operation -
Returns:
Map

getSrvcName

java.lang.String getSrvcName(org.openptk.common.Operation operation,
                             java.lang.String name)
Parameters:
operation -
name -
Returns:
String

getTimeout

int getTimeout(org.openptk.common.Operation operation)
Parameters:
operation -
Returns:
int

hasOperation

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

hasOperation

boolean hasOperation(java.lang.String opstr)
Parameters:
opstr -
Returns:
boolean

setAssociation

void setAssociation(org.openptk.common.Operation operation,
                    org.openptk.common.ComponentIF comp)
Parameters:
operation -
comp -

setAttrGroup

void setAttrGroup(org.openptk.common.Operation operation,
                  org.openptk.common.ComponentIF comp)
Parameters:
operation -
comp -

setContext

void setContext(org.openptk.context.ContextIF context)
Parameters:
context -

setFw2SrvcNames

void setFw2SrvcNames(org.openptk.common.Operation operation,
                     java.util.Map<java.lang.String,java.lang.String> map)
Parameters:
operation -
map -

setKey

void setKey(org.openptk.common.Operation operation,
            java.lang.String key)
Parameters:
operation -
key -

setOperation

void setOperation(org.openptk.common.Operation oper,
                  OperationsIF operation)
Parameters:
oper -
operation -

setOperAttr

void setOperAttr(org.openptk.common.Operation operation,
                 org.openptk.common.ComponentIF comp)
Parameters:
operation -
comp -

setOperProps

void setOperProps(org.openptk.common.Operation operation,
                  java.util.Properties props)
Parameters:
operation -
props -

setQuery

void setQuery(org.openptk.common.Operation operation,
              Query query)
Parameters:
operation -
query -

setSortAttributes

void setSortAttributes(java.util.List<java.lang.String> sortBy)
Parameters:
sortBy -

setSrvc2FwNames

void setSrvc2FwNames(org.openptk.common.Operation operation,
                     java.util.Map<java.lang.String,java.lang.String> map)
Parameters:
operation -
map -

setTimeout

void setTimeout(org.openptk.common.Operation operation,
                int msec)
Parameters:
operation -
msec -

shutdown

void shutdown()

startup

void startup()

toFw

java.lang.String[] toFw(org.openptk.common.Operation operation,
                        java.lang.String[] fw)
Parameters:
operation -
fw -
Returns:
String[]

toSrvc

java.lang.String[] toSrvc(org.openptk.common.Operation operation,
                          java.lang.String[] fw)
Parameters:
operation -
fw -
Returns:
String[]
Overview  Package   Class  Tree  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD
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