| java.lang.Object
 org.xins.common.manageable.Manageable
org.xins.server.Function
| Function | | abstract public class Function extends Manageable (Code) | | Base class for function implementation classes.
A function can be enabled or disabled using the
Function.setEnabled(boolean) method. A function that is enabled can be
invoked, while a function that is disabled cannot. By default a function
is enabled.
version:
$Revision: 1.156 $ $Date: 2007/08/29 11:39:47 $
author:
Ernst de Haan
since:
XINS 1.0.0 |
| Function | | protected Function(API api, String name, String version) throws IllegalArgumentException(Code) | | Constructs a new Function.
Parameters:
api - the API to which this function belongs, not null.
Parameters:
name - the name, not null.
Parameters:
version - the version of the specification this function implements, notnull.
throws:
IllegalArgumentException - if api == null || name == null || version == null. |
| assignCallID | | final int assignCallID()(Code) | | Assigns a new call ID for the caller. Every call to this method will
return an increasing number.
the assigned call ID, >= 0. |
| getAPI | | final public API getAPI()(Code) | | Returns the API that contains this function.
the API, not null. |
| getName | | final public String getName()(Code) | | Returns the name of this function.
the name, not null.
since:
XINS 1.5.0. |
| getStatistics | | final FunctionStatistics getStatistics()(Code) | | Returns the call statistics for this function.
the statistics, never null. |
| getVersion | | final String getVersion()(Code) | | Returns the specification version for this function.
the version, not null. |
| handleCall | | abstract protected FunctionResult handleCall(CallContext context) throws Throwable(Code) | | Handles a call to this function.
Parameters:
context - the context for this call, never null.the result of the call, never null.
throws:
Throwable - if anything goes wrong. |
| isEnabled | | final public boolean isEnabled()(Code) | | Checks if this function is currently accessible.
true if this function is currently accessible,false otherwise.
See Also: Function.setEnabled(boolean) |
| setEnabled | | final public void setEnabled(boolean enabled)(Code) | | Sets if this function is currently accessible.
Parameters:
enabled - true if this function should be accessible,false if not.
See Also: Function.isEnabled() |
| Methods inherited from org.xins.common.manageable.Manageable | final protected void assertUsable() throws IllegalStateException(Code)(Java Doc)
final public void bootstrap(PropertyReader properties) throws IllegalStateException, MissingRequiredPropertyException, InvalidPropertyValueException, BootstrapException(Code)(Java Doc)
protected void bootstrapImpl(PropertyReader properties) throws MissingRequiredPropertyException, InvalidPropertyValueException, BootstrapException(Code)(Java Doc)
final public void deinit() throws IllegalStateException, DeinitializationException(Code)(Java Doc)
protected void deinitImpl() throws Throwable(Code)(Java Doc)
final public State getState()(Code)(Java Doc)
final public void init(PropertyReader properties) throws IllegalStateException, MissingRequiredPropertyException, InvalidPropertyValueException, InitializationException(Code)(Java Doc)
protected void initImpl(PropertyReader properties) throws MissingRequiredPropertyException, InvalidPropertyValueException, InitializationException(Code)(Java Doc)
final public boolean isBootstrapped()(Code)(Java Doc)
final public boolean isUsable()(Code)(Java Doc)
|
|
|