properties) {
this.properties.putAll(properties);
return this;
}
/**
* Adds class-level bean filters to this resource.
*
*
* This is the programmatic equivalent to the {@link RestResource#beanFilters() @RestResource.beanFilters()}
* annotation.
*
*
* Values are added AFTER those found in the annotation and therefore take precedence over those defined via the
* annotation.
*
* @param beanFilters The bean filters to add to this config.
* @return This object (for method chaining).
*/
public RestConfig addBeanFilters(Class...beanFilters) {
this.beanFilters.addAll(Arrays.asList(beanFilters));
return this;
}
/**
* Adds class-level pojo swaps to this resource.
*
*
* This is the programmatic equivalent to the {@link RestResource#pojoSwaps() @RestResource.pojoSwaps()} annotation.
*
*
* Values are added AFTER those found in the annotation and therefore take precedence over those defined via the
* annotation.
*
* @param pojoSwaps The pojo swaps to add to this config.
* @return This object (for method chaining).
*/
public RestConfig addPojoSwaps(Class...pojoSwaps) {
this.pojoSwaps.addAll(Arrays.asList(pojoSwaps));
return this;
}
/**
* Specifies the serializer listener class to use for listening to non-fatal serialization errors.
*
*
* This is the programmatic equivalent to the
* {@link RestResource#serializerListener() @RestResource.serializerListener()} annotation.
*
* @param listener The listener to add to this config.
* @return This object (for method chaining).
*/
public RestConfig serializerListener(Class listener) {
if (listener != SerializerListener.class)
this.serializerListener = listener;
return this;
}
/**
* Specifies the parser listener class to use for listening to non-fatal parse errors.
*
*
* This is the programmatic equivalent to the
* {@link RestResource#parserListener() @RestResource.parserListener()} annotation.
*
* @param listener The listener to add to this config.
* @return This object (for method chaining).
*/
public RestConfig parserListener(Class listener) {
if (listener != ParserListener.class)
this.parserListener = listener;
return this;
}
/**
* Specifies the override context path for this resource.
*
*
* This is the programmatic equivalent to the
* {@link RestResource#contextPath() @RestResource.contextPath()} annotation.
*
* @param contextPath The context path for this resource and any child resources.
* @return This object (for method chaining).
*/
public RestConfig contextPath(String contextPath) {
if (! contextPath.isEmpty())
this.contextPath = contextPath;
return this;
}
/**
* Adds class-level parameter resolvers to this resource.
*
*
* This is the programmatic equivalent to the
* {@link RestResource#paramResolvers() @RestResource.paramResolvers()} annotation.
*
* @param paramResolvers The parameter resolvers to add to this config.
* @return This object (for method chaining).
*/
@SuppressWarnings("unchecked")
public RestConfig addParamResolvers(Class...paramResolvers) {
this.paramResolvers.addAll(Arrays.asList(paramResolvers));
return this;
}
/**
* Adds class-level serializers to this resource.
*
*
* This is the programmatic equivalent to the {@link RestResource#serializers() @RestResource.serializers()}
* annotation.
*
*
* Values are added AFTER those found in the annotation and therefore take precedence over those defined via the
* annotation.
*
* @param serializers The serializer classes to add to this config.
* @return This object (for method chaining).
*/
public RestConfig addSerializers(Class...serializers) {
this.serializers.append(serializers);
return this;
}
/**
* Adds class-level serializers to this resource.
*
*
* Same as {@link #addSerializers(Class...)} except allows you to pass in serializer instances.
* The actual serializer ends up being the result of this operation using the bean filters, pojo swaps, and
* properties on this config:
*
* serializer = serializer.builder().beanFilters(beanFilters).pojoSwaps(pojoSwaps).properties(properties).build();
*
*
*
* Values are added AFTER those found in the annotation and therefore take precedence over those defined via the
* annotation.
*
* @param serializers The serializers to add to this config.
* @return This object (for method chaining).
*/
public RestConfig addSerializers(Serializer...serializers) {
this.serializers.append(serializers);
return this;
}
/**
* Adds class-level parsers to this resource.
*
*
* This is the programmatic equivalent to the {@link RestResource#parsers() @RestResource.parsers()} annotation.
*
*
* Values are added AFTER those found in the annotation and therefore take precedence over those defined via the
* annotation.
*
* @param parsers The parser classes to add to this config.
* @return This object (for method chaining).
*/
public RestConfig addParsers(Class...parsers) {
this.parsers.append(parsers);
return this;
}
/**
* Adds class-level parsers to this resource.
*
*
* Same as {@link #addParsers(Class...)} except allows you to pass in parser instances.
* The actual parser ends up being the result of this operation using the bean filters, pojo swaps, and properties
* on this config:
*
* parser = parser.builder().beanFilters(beanFilters).pojoSwaps(pojoSwaps).properties(properties).build();
*
*
*
* Values are added AFTER those found in the annotation and therefore take precedence over those defined via the
* annotation.
*
* @param parsers The parsers to add to this config.
* @return This object (for method chaining).
*/
public RestConfig addParsers(Parser...parsers) {
this.parsers.append(parsers);
return this;
}
/**
* Adds class-level encoders to this resource.
*
*
* This is the programmatic equivalent to the {@link RestResource#encoders() @RestResource.encoders()} annotation.
*
*
* Values are added AFTER those found in the annotation and therefore take precedence over those defined via the
* annotation.
*
*
* By default, only the {@link IdentityEncoder} is included in this list.
*
* @param encoders The parser classes to add to this config.
* @return This object (for method chaining).
*/
public RestConfig addEncoders(Class...encoders) {
this.encoders.append(encoders);
return this;
}
/**
* Adds class-level encoders to this resource.
*
*
* Same as {@link #addEncoders(Class...)} except allows you to pass in encoder instances.
*
* @param encoders The encoders to add to this config.
* @return This object (for method chaining).
*/
public RestConfig addEncoders(Encoder...encoders) {
this.encoders.append(encoders);
return this;
}
/**
* Adds class-level converters to this resource.
*
*
* This is the programmatic equivalent to the {@link RestResource#converters() @RestResource.converters()}
* annotation.
*
*
* Values are added AFTER those found in the annotation and therefore take precedence over those defined via the
* annotation.
*
*
* By default, this config includes the following converters:
*
* {@link StreamableHandler}
* {@link WritableHandler}
* {@link ReaderHandler}
* {@link InputStreamHandler}
* {@link RedirectHandler}
* {@link DefaultHandler}
*
*
* @param converters The converter classes to add to this config.
* @return This object (for method chaining).
*/
public RestConfig addConverters(Class...converters) {
this.converters.addAll(Arrays.asList(converters));
return this;
}
/**
* Adds class-level encoders to this resource.
*
*
* Same as {@link #addConverters(Class...)} except allows you to pass in converter instances.
*
* @param converters The converters to add to this config.
* @return This object (for method chaining).
*/
public RestConfig addConverters(RestConverter...converters) {
this.converters.addAll(Arrays.asList(converters));
return this;
}
/**
* Adds class-level guards to this resource.
*
*
* This is the programmatic equivalent to the {@link RestResource#guards() @RestResource.guards()} annotation.
*
*
* Values are added AFTER those found in the annotation and therefore take precedence over those defined via the
* annotation.
*
* @param guards The guard classes to add to this config.
* @return This object (for method chaining).
*/
public RestConfig addGuards(Class...guards) {
this.guards.addAll(Arrays.asList(guards));
return this;
}
/**
* Adds class-level guards to this resource.
*
*
* Same as {@link #addGuards(Class...)} except allows you to pass in guard instances.
*
* @param guards The guards to add to this config.
* @return This object (for method chaining).
*/
public RestConfig addGuards(RestGuard...guards) {
this.guards.addAll(Arrays.asList(guards));
return this;
}
/**
* Adds MIME-type definitions.
*
*
* These definitions are used in the following locations for setting the media type on responses:
*
* {@link RestRequest#getReaderResource(String)}
* Static files resolved through {@link RestResource#staticFiles()}
*
*
*
* Refer to {@link MimetypesFileTypeMap#addMimeTypes(String)} for an explanation of the format.
*
* @param mimeTypes The MIME-types to add to this config.
* @return This object (for method chaining).
*/
public RestConfig addMimeTypes(String...mimeTypes) {
if (this.mimeTypes == ExtendedMimetypesFileTypeMap.DEFAULT)
this.mimeTypes = new ExtendedMimetypesFileTypeMap();
for (String mimeType : mimeTypes)
this.mimeTypes.addMimeTypes(mimeType);
return this;
}
/**
* Adds class-level default HTTP request headers to this resource.
*
*
* Default request headers are default values for when HTTP requests do not specify a header value.
* For example, you can specify a default value for Accept if a request does not specify that header
* value.
*
*
* This is the programmatic equivalent to the
* {@link RestResource#defaultRequestHeaders() @RestResource.defaultRequestHeaders()} annotation.
*
* @param name The HTTP header name.
* @param value The HTTP header value.
* @return This object (for method chaining).
*/
public RestConfig addDefaultRequestHeader(String name, Object value) {
this.defaultRequestHeaders.put(name, StringUtils.toString(value));
return this;
}
/**
* Adds class-level default HTTP request headers to this resource.
*
*
* Default request headers are default values for when HTTP requests do not specify a header value.
* For example, you can specify a default value for Accept if a request does not specify that header
* value.
*
*
* This is the programmatic equivalent to the
* {@link RestResource#defaultRequestHeaders() @RestResource.defaultRequestHeaders()} annotation.
*
* @param headers HTTP headers of the form "Name: Value" .
* @return This object (for method chaining).
* @throws RestServletException If header string is not correctly formatted.
*/
public RestConfig addDefaultRequestHeaders(String...headers) throws RestServletException {
for (String header : headers) {
String[] h = RestUtils.parseHeader(header);
if (h == null)
throw new RestServletException("Invalid default request header specified: ''{0}''. Must be in the format: ''Header-Name: header-value''", header);
addDefaultRequestHeader(h[0], h[1]);
}
return this;
}
/**
* Adds class-level default HTTP response headers to this resource.
*
*
* Default response headers are headers that will be appended to all responses if those headers have not already been
* set on the response object.
*
*
* This is the programmatic equivalent to the
* {@link RestResource#defaultResponseHeaders() @RestResource.defaultResponseHeaders()} annotation.
*
*
* Values are added AFTER those found in the annotation and therefore take precedence over those defined via the
* annotation.
*
* @param name The HTTP header name.
* @param value The HTTP header value.
* @return This object (for method chaining).
*/
public RestConfig addDefaultResponseHeader(String name, Object value) {
this.defaultResponseHeaders.put(name, value);
return this;
}
/**
* Adds class-level default HTTP response headers to this resource.
*
*
* Default response headers are headers that will be appended to all responses if those headers have not already been
* set on the response object.
*
*
* This is the programmatic equivalent to the
* {@link RestResource#defaultResponseHeaders() @RestResource.defaultResponseHeaders()} annotation.
*
* @param headers HTTP headers of the form "Name: Value" .
* @return This object (for method chaining).
* @throws RestServletException If header string is not correctly formatted.
*/
public RestConfig addDefaultResponseHeaders(String...headers) throws RestServletException {
for (String header : headers) {
String[] h = RestUtils.parseHeader(header);
if (h == null)
throw new RestServletException("Invalid default response header specified: ''{0}''. Must be in the format: ''Header-Name: header-value''", header);
addDefaultResponseHeader(h[0], h[1]);
}
return this;
}
/**
* Adds class-level response handler classes to this resource.
*
*
* Response handlers are responsible for converting various POJOs returned by REST methods into actual HTTP responses.
*
*
* By default, this config includes the following response handlers:
*
* {@link StreamableHandler}
* {@link WritableHandler}
* {@link ReaderHandler}
* {@link InputStreamHandler}
* {@link RedirectHandler}
* {@link DefaultHandler}
*
*
*
* This is the programmatic equivalent to the
* {@link RestResource#responseHandlers() @RestResource.responseHandlers()} annotation.
*
* @param responseHandlers The response handlers to add to this config.
* @return This object (for method chaining).
*/
public RestConfig addResponseHandlers(Class...responseHandlers) {
this.responseHandlers.addAll(Arrays.asList(responseHandlers));
return this;
}
/**
* Adds class-level response handlers to this resource.
*
*
* Same as {@link #addResponseHandlers(Class...)} except allows you to pass in response handler instances.
*
* @param responseHandlers The response handlers to add to this config.
* @return This object (for method chaining).
*/
public RestConfig addResponseHandlers(ResponseHandler...responseHandlers) {
this.responseHandlers.addAll(Arrays.asList(responseHandlers));
return this;
}
/**
* Adds a child resource to this resource.
*
*
* Child resources are resources that are accessed under the path of the parent resource.
*
*
* This is the programmatic equivalent to the {@link RestResource#children() @RestResource.children()} annotation.
*
* @param path The child path of the resource. Must conform to {@link RestResource#path()} format.
* @param child The child resource.
* @return This object (for method chaining).
*/
public RestConfig addChildResource(String path, Object child) {
this.childResources.add(new Pair(path, child));
return this;
}
/**
* Add child resources to this resource.
*
*
* Child resources are resources that are accessed under the path of the parent resource.
*
*
* This is the programmatic equivalent to the {@link RestResource#children() @RestResource.children()} annotation.
*
* @param children The child resources to add to this resource.
* Children must be annotated with {@link RestResource#path()} to identify the child path.
* @return This object (for method chaining).
*/
public RestConfig addChildResources(Object...children) {
this.childResources.addAll(Arrays.asList(children));
return this;
}
/**
* Add child resources to this resource.
*
*
* Child resources are resources that are accessed under the path of the parent resource.
*
*
* This is the programmatic equivalent to the {@link RestResource#children() @RestResource.children()} annotation.
*
* @param children The child resources to add to this resource.
* Children must be annotated with {@link RestResource#path()} to identify the child path.
* @return This object (for method chaining).
*/
public RestConfig addChildResources(Class...children) {
this.childResources.addAll(Arrays.asList(children));
return this;
}
/**
* Specifies the list of supported Accept media types for this resource.
*
*
* This overrides the media types inferred from the parsers on this resource.
*
*
* There is no annotation equivalent to this method call.
*
* @param mediaTypes The new list of media types supported by this resource.
* @return This object (for method chaining).
*/
public RestConfig setSupportedAcceptTypes(String...mediaTypes) {
supportedAcceptTypes = new ArrayList();
for (String mediaType : mediaTypes)
supportedAcceptTypes.add(MediaType.forString(mediaType));
return this;
}
/**
* Specifies the list of supported Accept media types for this resource.
*
*
* This overrides the media types inferred from the parsers on this resource.
*
*
* There is no annotation equivalent to this method call.
*
* @param mediaTypes The new list of media types supported by this resource.
* @return This object (for method chaining).
*/
public RestConfig setSupportedAcceptTypes(MediaType...mediaTypes) {
supportedAcceptTypes = Arrays.asList(mediaTypes);
return this;
}
/**
* Specifies the list of supported Content-Type media types for this resource.
*
*
* This overrides the media types inferred from the serializers on this resource.
*
*
* There is no annotation equivalent to this method call.
*
* @param mediaTypes The new list of media types supported by this resource.
* @return This object (for method chaining).
*/
public RestConfig setSupportedContentTypes(String...mediaTypes) {
supportedContentTypes = new ArrayList();
for (String mediaType : mediaTypes)
supportedContentTypes.add(MediaType.forString(mediaType));
return this;
}
/**
* Specifies the list of supported Content-Type media types for this resource.
*
*
* This overrides the media types inferred from the serializers on this resource.
*
*
* There is no annotation equivalent to this method call.
*
* @param mediaTypes The new list of media types supported by this resource.
* @return This object (for method chaining).
*/
public RestConfig setSupportedContentTypes(MediaType...mediaTypes) {
supportedContentTypes = Arrays.asList(mediaTypes);
return this;
}
/**
* Appends to the static files resource map.
*
*
* Use this method to specify resources located in the classpath to be served up as static files.
*
*
* This is the programmatic equivalent to the {@link RestResource#staticFiles() @RestResource.staticFiles()}
* annotation.
*
* @param resourceClass The resource class used to resolve the resource streams.
* @param staticFilesString
* A JSON string denoting a map of child URLs to classpath subdirectories.
* For example, if this string is "{htdocs:'docs'}" with class com.foo.MyResource,
* then URLs of the form "/resource-path/htdocs/..." will resolve to files located in the
* com.foo.docs package.
* @return This object (for method chaining).
*/
public RestConfig addStaticFiles(Class resourceClass, String staticFilesString) {
if (staticFiles == null)
staticFiles = new ArrayList();
staticFiles.add(new Pair,Object>(resourceClass, staticFilesString));
return this;
}
/**
* Overrides the default REST resource resolver.
*
*
* The resource resolver is used to resolve instances from {@link Class} objects defined in the
* {@link RestResource#children()} annotation.
* The default value is {@link RestResourceResolverSimple}.
*
*
* This is the programmatic equivalent to the
* {@link RestResource#resourceResolver() @RestResource.resourceResolver()} annotation.
*
* @param resourceResolver The new resource resolver.
* @return This object (for method chaining).
*/
public RestConfig setResourceResolver(Class resourceResolver) {
this.resourceResolver = resourceResolver;
return this;
}
/**
* Overrides the default REST resource resolver.
*
*
* Same as {@link #setResourceResolver(Class)} except allows you to specify an instance instead of a class.
*
* @param resourceResolver The new resource resolver.
* @return This object (for method chaining).
*/
public RestConfig setResourceResolver(RestResourceResolver resourceResolver) {
this.resourceResolver = resourceResolver;
return this;
}
/**
* Sets the allowHeaderParams setting on this resource.
*
*
* This is the programmatic equivalent to the {@link RestResource#allowHeaderParams() RestResource.allowHeaderParams()} annotation.
*
* @param value The new value for this setting.
* @return This object (for method chaining).
*/
public RestConfig setAllowHeaderParams(boolean value) {
this.allowHeaderParams = value;
return this;
}
/**
* Sets the allowMethodParam setting on this resource.
*
*
* This is the programmatic equivalent to the {@link RestResource#allowMethodParam() RestResource.allowMethodParam()} annotation.
*
* @param value The new value for this setting.
* @return This object (for method chaining).
*/
public RestConfig setAllowMethodParam(String...value) {
this.allowMethodParam = StringUtils.join(value, ',');
return this;
}
/**
* Sets the allowBodyParam setting on this resource.
*
*
* This is the programmatic equivalent to the {@link RestResource#allowBodyParam() RestResource.allowBodyParam()} annotation.
*
* @param value The new value for this setting.
* @return This object (for method chaining).
*/
public RestConfig setAllowBodyParam(boolean value) {
this.allowBodyParam = value;
return this;
}
/**
* Sets the renderResponseStackTraces setting on this resource.
*
*
* This is the programmatic equivalent to the {@link RestResource#renderResponseStackTraces() RestResource.renderResponseStackTraces()} annotation.
*
* @param value The new value for this setting.
* @return This object (for method chaining).
*/
public RestConfig setRenderResponseStackTraces(boolean value) {
this.renderResponseStackTraces = value;
return this;
}
/**
* Sets the useStackTraceHashes setting on this resource.
*
*
* This is the programmatic equivalent to the {@link RestResource#useStackTraceHashes() RestResource.useStackTraceHashes()} annotation.
*
* @param value The new value for this setting.
* @return This object (for method chaining).
*/
public RestConfig setUseStackTraceHashes(boolean value) {
this.useStackTraceHashes = value;
return this;
}
/**
* Sets the defaultCharset setting on this resource.
*
*
* This is the programmatic equivalent to the {@link RestResource#defaultCharset() RestResource.defaultCharset()} annotation.
*
* @param value The new value for this setting.
* @return This object (for method chaining).
*/
public RestConfig setDefaultCharset(String value) {
this.defaultCharset = value;
return this;
}
/**
* Sets the paramFormat setting on this resource.
*
*
* This is the programmatic equivalent to the {@link RestResource#paramFormat() RestResource.paramFormat()} annotation.
*
* @param value The new value for this setting.
* @return This object (for method chaining).
*/
public RestConfig setParamFormat(String value) {
this.paramFormat = value;
return this;
}
/**
* Sets the URL path of the resource "/foobar" .
*
*
* This is the programmatic equivalent to the {@link RestResource#path() @RestResource.path()} annotation.
*
* @param path The URL path of this resource.
* @return This object (for method chaining).
*/
public RestConfig setPath(String path) {
if (startsWith(path, '/'))
path = path.substring(1);
this.path = path;
return this;
}
/**
* Sets name of the header used to denote the client version on HTTP requests.
*
*
* This is the programmatic equivalent to the
* {@link RestResource#clientVersionHeader() @RestResource.clientVersionHeader()} annotation.
*
* @param clientVersionHeader The name of the HTTP header that denotes the client version.
* @return This object (for method chaining).
*/
public RestConfig setClientVersionHeader(String clientVersionHeader) {
this.clientVersionHeader = clientVersionHeader;
return this;
}
/**
* Defines widgets that can be used in conjunction with string variables of the form "$W{name}" to quickly
* generate arbitrary replacement text.
*
*
* Widgets are inherited from parent to child, but can be overridden by reusing the widget name.
*
* @param value The widget class to add.
* @return This object (for method chaining).
*/
public RestConfig addWidget(Class value) {
this.widgets.add(value);
return this;
}
/**
* Returns an instance of an HTMLDOC builder for setting HTMLDOC-related properties.
*
* @return An instance of an HTMLDOC builder for setting HTMLDOC-related properties.
*/
public HtmlDocBuilder getHtmlDocBuilder() {
return htmlDocBuilder;
}
/**
* Overrides the logger for the resource.
*
*
* This is the programmatic equivalent to the {@link RestResource#logger() @RestResource.logger()} annotation.
*
* @param logger The new logger for this resource. Can be null to disable logging.
* @return This object (for method chaining).
*/
public RestConfig setLogger(Class logger) {
this.logger = logger;
return this;
}
/**
* Overrides the logger for the resource.
*
*
* This is the programmatic equivalent to the {@link RestResource#logger() @RestResource.logger()} annotation.
*
* @param logger The new logger for this resource. Can be null to disable logging.
* @return This object (for method chaining).
*/
public RestConfig setLogger(RestLogger logger) {
this.logger = logger;
return this;
}
/**
* Overrides the call handler for the resource.
*
*
* The call handler is the object that handles execution of REST HTTP calls.
* Subclasses can be created that customize the behavior of how REST calls are handled.
*
*
* This is the programmatic equivalent to the {@link RestResource#callHandler() @RestResource.callHandler()}
* annotation.
*
* @param restHandler The new call handler for this resource.
* @return This object (for method chaining).
*/
public RestConfig setCallHandler(Class restHandler) {
this.callHandler = restHandler;
return this;
}
/**
* Overrides the call handler for the resource.
*
*
* The call handler is the object that handles execution of REST HTTP calls.
* Subclasses can be created that customize the behavior of how REST calls are handled.
*
*
* This is the programmatic equivalent to the {@link RestResource#callHandler() @RestResource.callHandler()}
* annotation.
*
* @param restHandler The new call handler for this resource.
* @return This object (for method chaining).
*/
public RestConfig setCallHandler(RestCallHandler restHandler) {
this.callHandler = restHandler;
return this;
}
/**
* Overrides the info provider for the resource.
*
*
* The info provider provides all the various information about a resource such as the Swagger documentation.
* Subclasses can be created that customize the information.
*
*
* This is the programmatic equivalent to the {@link RestResource#infoProvider() @RestResource.infoProvider()}
* annotation.
*
* @param infoProvider The new info provider for this resource.
* @return This object (for method chaining).
*/
public RestConfig setInfoProvider(Class infoProvider) {
this.infoProvider = infoProvider;
return this;
}
/**
* Overrides the info provider for the resource.
*
*
* The info provider provides all the various information about a resource such as the Swagger documentation.
* Subclasses can be created that customize the information.
*
*
* This is the programmatic equivalent to the {@link RestResource#infoProvider() @RestResource.infoProvider()}
* annotation.
*
* @param infoProvider The new info provider for this resource.
* @return This object (for method chaining).
*/
public RestConfig setInfoProvider(RestInfoProvider infoProvider) {
this.infoProvider = infoProvider;
return this;
}
/**
* Creates a new {@link PropertyStore} object initialized with the properties defined in this config.
*
* @return A new property store.
*/
protected PropertyStore createPropertyStore() {
return PropertyStore.create().addProperties(properties);
}
//----------------------------------------------------------------------------------------------------
// Methods that give access to the config file, var resolver, and properties.
//----------------------------------------------------------------------------------------------------
/**
* Returns the external configuration file for this resource.
*
*
* The configuration file location is determined via the {@link RestResource#config() @RestResource.config()}
* annotation on the resource.
*
*
* The config file can be programmatically overridden by adding the following method to your resource:
*
* public ConfigFile createConfigFile(ServletConfig servletConfig) throws ServletException;
*
*
*
* If a config file is not set up, then an empty config file will be returned that is not backed by any file.
*
* @return The external config file for this resource. Never null .
*/
public ConfigFile getConfigFile() {
return configFile;
}
/**
* Returns the configuration properties for this resource.
*
*
* The configuration properties are determined via the {@link RestResource#properties()} annotation on the resource.
*
*
* The configuration properties can be augmented programmatically by adding the following method to your resource:
*
* public ObjectMap createProperties(ServletConfig servletConfig) throws ServletException;
*
*
*
* These properties can be modified during servlet initialization.
* However, any modifications made after {@link RestServlet#init(ServletConfig)} has been called will have no effect.
*
* @return The configuration properties for this resource. Never null .
*/
public ObjectMap getProperties() {
return properties;
}
/**
* Creates the variable resolver for this resource.
*
*
* The variable resolver returned by this method can resolve the following variables:
*
* {@link SystemPropertiesVar}
* {@link EnvVariablesVar}
* {@link ConfigFileVar}
* {@link IfVar}
* {@link SwitchVar}
*
*
*
* Note that the variables supported here are only a subset of those returned by
* {@link RestRequest#getVarResolverSession()}.
*
* @return The variable resolver for this resource. Never null .
*/
public VarResolverBuilder getVarResolverBuilder() {
return varResolverBuilder;
}
//----------------------------------------------------------------------------------------------------
// Methods inherited from ServletConfig
//----------------------------------------------------------------------------------------------------
@Override /* ServletConfig */
public String getInitParameter(String name) {
return inner.getInitParameter(name);
}
@Override /* ServletConfig */
public Enumeration getInitParameterNames() {
return inner.getInitParameterNames();
}
@Override /* ServletConfig */
public ServletContext getServletContext() {
return inner.getServletContext();
}
@Override /* ServletConfig */
public String getServletName() {
return inner.getServletName();
}
}
