Package org.restheart.plugins

Interface PluginsRegistry

public interface PluginsRegistry

Author:

Andrea Di Cesare <andrea@softinstigate.com>

Method Summary

Modifier and Type	Method	Description
PluginRecord<Authenticator>	getAuthenticator(String name)
Set<PluginRecord<Authenticator>>	getAuthenticators()
Set<PluginRecord<AuthMechanism>>	getAuthMechanisms()
Set<PluginRecord<Authorizer>>	getAuthorizers()
Set<io.undertow.predicate.Predicate>	getGlobalSecurityPredicates()	global security predicates must all resolve to true to allow the request
Set<PluginRecord<Initializer>>	getInitializers()
Set<PluginRecord<Interceptor>>	getInterceptors()
PipelineInfo	getPipelineInfo(String path)
io.undertow.server.handlers.PathHandler	getRootPathHandler()	Gets the RESTHeart root handler Avoid adding handlers using PathHandler.addPrefixPath() or PathHandler.addExactPath().
Set<PluginRecord<Service>>	getServices()
PluginRecord<TokenManager>	getTokenManager()
void	plugPipeline(String path, PipelinedHandler handler, PipelineInfo info)	Plugs a pipeline into the root handler binding it to the path; also sets its PipelineInfo.

Method Detail

getAuthMechanisms

Set<PluginRecord<AuthMechanism>> getAuthMechanisms()

Returns:

the authMechanisms

getAuthenticators

Set<PluginRecord<Authenticator>> getAuthenticators()

Returns:

the authenticators

getAuthenticator

PluginRecord<Authenticator> getAuthenticator(String name)
                                      throws ConfigurationException

Parameters:

name - the name of the authenticator

Returns:

the authenticator

Throws:

ConfigurationException

getTokenManager

PluginRecord<TokenManager> getTokenManager()

Returns:

the authenticators

getAuthorizers

Set<PluginRecord<Authorizer>> getAuthorizers()

Returns:

the authenticators

getInitializers

Set<PluginRecord<Initializer>> getInitializers()

Returns:

the initializers

getServices

Set<PluginRecord<Service>> getServices()

Returns:

the services

getInterceptors

Set<PluginRecord<Interceptor>> getInterceptors()

getGlobalSecurityPredicates

Set<io.undertow.predicate.Predicate> getGlobalSecurityPredicates()

global security predicates must all resolve to true to allow the request

Returns:

the globalSecurityPredicates allow to get and set the global security predicates to apply to all requests

getRootPathHandler

io.undertow.server.handlers.PathHandler getRootPathHandler()

Gets the RESTHeart root handler Avoid adding handlers using PathHandler.addPrefixPath() or PathHandler.addExactPath(). Instead use PluginsRegistry.plug() which sets also the correct PipelineInfo

Returns:

the RESTHeart root handler

plugPipeline

void plugPipeline(String path,
                  PipelinedHandler handler,
                  PipelineInfo info)

Plugs a pipeline into the root handler binding it to the path; also sets its PipelineInfo.

Parameters:

path - If the request contains this path, run the pipeline

handler - The handler which is activated upon match

info - The PipelineInfo describing the handling pipeline

getPipelineInfo

PipelineInfo getPipelineInfo(String path)

Parameters:

path -

Returns:

the PipelineInfo of the pipeline handling the request