com.gridsystems.innergrid.kernel.api
Interface ApiRegistry

All Known Implementing Classes:

ApiConfiguration, NullApiRegistry

public interface ApiRegistry

Classes implementing this interface are responsible of registering public APIs and beans.

Version:

1.0

Author:

Rodrigo Ruiz

Method Summary

void	addRequestFilter(RequestFilter requestFilter) Adds a RequestFilter.
AAService	getAAS(java.lang.String apiName) Gets the authenticator associated to the specified apiName.
java.rmi.Remote	getApi(java.lang.String apiName) Gets an instance of the specified API.
java.lang.String[]	getApiNames() Gets the list of registered API names.
ApiReflector	getReflector(java.lang.String apiName) Gets the reflector for the specified API.
java.util.List	getRequestFilters() Gets the list of RequestFilter set.
void	register(ApiReflector reflector) Registers the specified object.
void	registerWSDD(java.io.InputStream wsddIS) Registers the specified wsdd.
void	registerWSDD(java.net.URL wsddURL) Registers the specified wsdd.
boolean	removeRequestFilter(RequestFilter requestFilter) Removes a RequestFilter.
void	setAAS(java.lang.String apiName, AAService a) Associates an "authenticator" to an API by its name.

Method Detail

register

void register(ApiReflector reflector)

Registers the specified object.

Parameters:

reflector - An encapsulation of all data needed for API / Bean registry

registerWSDD

void registerWSDD(java.net.URL wsddURL)
                  throws java.lang.Exception

Registers the specified wsdd.

Parameters:

wsddURL - the wsdd url to register

Throws:

java.lang.Exception - If there is an error in the deployment descriptor

registerWSDD

void registerWSDD(java.io.InputStream wsddIS)
                  throws java.lang.Exception

Registers the specified wsdd.

Parameters:

wsddIS - the wsdd inputstream to register

Throws:

java.lang.Exception - If there is an error in the deployment descriptor

getAAS

AAService getAAS(java.lang.String apiName)

Gets the authenticator associated to the specified apiName.

This method MUST return the default authenticator if none is associated to this apiName. It SHOULD allow a null authenticator, for those services requiring no authentication regardless of the default configuration.

Parameters:

apiName - The name of the API

Returns:

The Authenticator instance associated to this API. It can be null if it has been explicitly said so.

setAAS

void setAAS(java.lang.String apiName,
            AAService a)

Associates an "authenticator" to an API by its name. Specifying a null authenticator MUST be a valid action. An API explicitly associated to null should override the default authenticator specified in Kernel.

Parameters:

apiName - The name of the API

a - The Authenticator to associate with

getApi

java.rmi.Remote getApi(java.lang.String apiName)

Gets an instance of the specified API.

Parameters:

apiName - The class name of the API interface, or the name of the API.

Returns:

An instance of the specified API

getReflector

ApiReflector getReflector(java.lang.String apiName)

Gets the reflector for the specified API.

Parameters:

apiName - The class name of the API interface, or the name of the API.

Returns:

The API reflector

getApiNames

java.lang.String[] getApiNames()

Gets the list of registered API names.

Returns:

The list of registered API names

getRequestFilters

java.util.List getRequestFilters()

Gets the list of RequestFilter set.

Returns:

a List with all the RequestFilter set.

addRequestFilter

void addRequestFilter(RequestFilter requestFilter)

Adds a RequestFilter.

Parameters:

requestFilter - the RequestFilter to be added.

removeRequestFilter

boolean removeRequestFilter(RequestFilter requestFilter)

Removes a RequestFilter.

Parameters:

requestFilter - the RequestFilter to be removed.

Returns:

a boolean that is true if and only if the requestFilter was successfully removed.