org.benow.service
Interface Service

All Superinterfaces:

org.benow.java.spec.Markup

All Known Subinterfaces:

ResourceService, SecurityService, ServiceService, TestService, TutorialSecureService, TutorialService

All Known Implementing Classes:

LocalServices, RemoteServices, SecurityServiceImpl, Services, ServiceServiceImpl, TestServiceImpl, TutorialSecureServiceImpl, TutorialServiceImpl

public interface Service
extends org.benow.java.spec.Markup

A service is a chunk of code that performs a declared function.

The service consists of set of methods, which may have a set of parameters and a return value.

Services are described for publication via annotations. The following annotations help to describe a service

On a service class

• Description - description of what the service does
• org.benow.security.Permission$RequiredPermission - permission required to view or access the service
• Publish - should this service be published by default. To hide a service (ie if stale), set Publish to false

On service methods

• Description - description of what method does
• ReturnDescription - description of what is returned
• Publish - should this method be available
• org.benow.security.Permission$RequiredPermission - required permission to view or invoke method

On method parameters

• ParamName - string representation of parameter name. Should be the same as the actual parameter name in code. It's redundant (afa the coder is concerned), but required as it is used during publication and for invocation param parsing the parameter names themselves are not available via reflection.
• Description - description of what this param is
• Required - is this param required. If set to false, the value is not required to be given (ie null is ok)

Service loading is done by the LocalServices.

Services may implement static methods which are called on certain service manager events. The methods are:

public static void onStart(LocalServices localServices);
Called when the service manager has started and the service is to be accessed for the first time.

public static void onStop(LocalServices localServices);
Called when the services are stopped and the service will never be called again.

These methods are optional, but will be called (via reflection) should they exist.

Nested Class Summary

Nested classes/interfaces inherited from interface org.benow.java.spec.Markup

org.benow.java.spec.Markup.ParamName, org.benow.java.spec.Markup.ReturnDescription