Class BaseUriDecorator
- java.lang.Object
-
- org.forgerock.openig.decoration.helper.AbstractDecorator
-
- org.forgerock.openig.decoration.helper.AbstractHandlerAndFilterDecorator
-
- org.forgerock.openig.decoration.baseuri.BaseUriDecorator
-
- All Implemented Interfaces:
Decorator
public class BaseUriDecorator extends AbstractHandlerAndFilterDecorator
The baseURI decorator can decorate bothFilter
andHandler
instances.It has to be declared inside of the heap objects section:
{ "name": "myBaseUri", "type": "BaseUriDecorator" }
config
element:{ "type": "...", "myBaseUri": "http://www.example.com", "config": { ... } }
The baseURI has to be a string otherwise, the decoration will be ignored.
N.B: The Gateway Servlet creates a default BaseUriDecorator named "baseURI" at startup time.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
BaseUriDecorator.Heaplet
Creates and initializes a baseUri in a heap environment.
-
Constructor Summary
Constructors Constructor Description BaseUriDecorator(String name)
Builds a newBaseUriDecorator
.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected DecorationHandle
decorateFilter(Filter delegate, JsonValue decoratorConfig, Context context)
protected DecorationHandle
decorateHandler(Handler delegate, JsonValue decoratorConfig, Context context)
-
Methods inherited from class org.forgerock.openig.decoration.helper.AbstractHandlerAndFilterDecorator
accepts, decorate
-
Methods inherited from class org.forgerock.openig.decoration.helper.AbstractDecorator
getLogger
-
-
-
-
Constructor Detail
-
BaseUriDecorator
public BaseUriDecorator(String name)
Builds a newBaseUriDecorator
.- Parameters:
name
- The name of this decorator.
-
-
Method Detail
-
decorateHandler
protected DecorationHandle decorateHandler(Handler delegate, JsonValue decoratorConfig, Context context)
Description copied from class:AbstractHandlerAndFilterDecorator
- Specified by:
decorateHandler
in classAbstractHandlerAndFilterDecorator
- Parameters:
delegate
- Handler instance to be decorateddecoratorConfig
- the decorator configuration to applycontext
- contextual information of the decorated instance- Returns:
- a handle to the decoration
-
decorateFilter
protected DecorationHandle decorateFilter(Filter delegate, JsonValue decoratorConfig, Context context)
Description copied from class:AbstractHandlerAndFilterDecorator
- Specified by:
decorateFilter
in classAbstractHandlerAndFilterDecorator
- Parameters:
delegate
- Filter instance to be decorateddecoratorConfig
- the decorator configuration to applycontext
- contextual information of the decorated instance- Returns:
- a handle to the decoration
-
-