ibrokerkit.iservicestore.store
Interface Forwarding

All Superinterfaces:

java.lang.Comparable<IService>, IService, java.io.Serializable

All Known Implementing Classes:

AbstractForwarding, DbForwarding

public interface Forwarding
extends IService

 A Forwarding i-service.
 Each Forwarding i-service holds a mapping from relative XRIs to URIs.
 The keys in this mapping are paths, and the values are URIs.
 E.g. (+blog) --> http://blog.mysite.com
 A Forwarding i-service can also support an Index Page and an Error Page, if
 the appropriate flags are turned on.
 

Method Summary

java.lang.Boolean	getErrorPage() Get a flag whether this Forwarding i-service should support an automatic error page at undefined mappings.
java.lang.Boolean	getIndexPage() Get a flag whether this Forwarding i-service should support an automatic index page at /(+index).
java.util.Map<java.lang.String,java.lang.String>	getMappings() Get the mappings associated with this Forwarding i-service.
void	setErrorPage(java.lang.Boolean errorPage) Set a flag whether this Forwarding i-service should support an automatic error page at undefined mappings.
void	setIndexPage(java.lang.Boolean indexPage) Set a flag whether this Forwarding i-service should support an automatic index page at /(+index).
void	setMappings(java.util.Map<java.lang.String,java.lang.String> mappings) Set the mappings associated with this Forwarding i-service.

Methods inherited from interface ibrokerkit.iservicestore.store.IService

getAttributes, getEnabled, getId, getIndx, getName, getQxri, getTimestamp, setAttributes, setEnabled, setIndx, setName, setQxri

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getIndexPage

java.lang.Boolean getIndexPage()

Get a flag whether this Forwarding i-service should support an automatic index page at /(+index).

Returns:

Index Page flag.

setIndexPage

void setIndexPage(java.lang.Boolean indexPage)

Set a flag whether this Forwarding i-service should support an automatic index page at /(+index).

Parameters:

indexPage - Index Page flag.

getErrorPage

java.lang.Boolean getErrorPage()

Get a flag whether this Forwarding i-service should support an automatic error page at undefined mappings.

Returns:

errorPage Error Page flag.

setErrorPage

void setErrorPage(java.lang.Boolean errorPage)

Set a flag whether this Forwarding i-service should support an automatic error page at undefined mappings.

Parameters:

errorPage - Error Page flag.

getMappings

java.util.Map<java.lang.String,java.lang.String> getMappings()

Get the mappings associated with this Forwarding i-service.

Returns:

Mappings.

setMappings

void setMappings(java.util.Map<java.lang.String,java.lang.String> mappings)

Set the mappings associated with this Forwarding i-service.

Parameters:

mappings - Mappings.