|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Assembler
This interface defines the component that converts a Definition to a URI, and converts a URI back into a Definition. Implementations are able to define the structure of their URI in any way allowed, provided that the rules of this interface are followed.
While it is not guaranteed that for a given Definition def and a given Assembler ua, that ua.assemble(def).equals(ua.assemble(ua.disassemble(ua.assemble(def)))), it is required that the arguments of a Definition passed into the assemble method will be identical to the arguments returned when the uri is disassembled.
Field Summary | |
---|---|
static java.lang.String |
LOG_NAME Logger name, for use with Jakarta Commons Logging. |
static java.lang.String |
PROP_PATH_PREFIX Property name prefix. |
static java.lang.String |
PROP_URIBASE_BLOB_SERVER Property name for the Blob Server app's uri path |
static java.lang.String |
PROP_URIBASE_CACHE_SERVER Property name for the Cache Server app's uri path |
static java.lang.String |
PROP_URIBASE_CATALOG_MANAGER Property name for the Catalog Manager app's uri path |
static java.lang.String |
PROP_URIBASE_CONTENT_SERVER Property name for the Content Server app's uri path |
static java.lang.String |
PROP_URIBASE_COOKIE_SERVER Property name for the Cookie Server app's uri path |
static java.lang.String |
PROP_URIBASE_DISPATCH_MANAGER Property name for the Dispatch Manager app's uri path |
static java.lang.String |
PROP_URIBASE_PAGE_DISPATCH_SERVER Property name for the Page Dispatch Server app's uri path |
static java.lang.String |
PROP_URIBASE_SATELLITE_SERVER Property name for the Satellite Server servlet's uri path. |
static java.lang.String |
PROP_URIBASE_SEED_DISPATCH_SERVER Property name for the Seed Dispatch Server app's uri path |
static java.lang.String |
PROP_URIBASE_SYNC_SEED_DISPATCH_SERVER Property name for the Sync Seed Dispatch Server app's uri path |
static java.lang.String |
PROP_URIBASE_TREE_MANAGER Property name for the Tree Manager app's uri path |
Method Summary | |
---|---|
java.net.URI |
assemble(Definition def) Construct a URI from a Definition. |
Definition |
disassemble(java.net.URI uri, Definition.ContainerType ct) This method disassembles a URI into its components, constructing a Definition object to provide conveniece accessors to the data encoded in the URI. |
void |
setProperties(java.util.Properties props) Sets the properties into the assembler. |
Field Detail |
---|
static final java.lang.String PROP_PATH_PREFIX
PROP_PATH_PREFIX
+ AppType
static final java.lang.String PROP_URIBASE_CONTENT_SERVER
static final java.lang.String PROP_URIBASE_BLOB_SERVER
static final java.lang.String PROP_URIBASE_CATALOG_MANAGER
static final java.lang.String PROP_URIBASE_TREE_MANAGER
static final java.lang.String PROP_URIBASE_COOKIE_SERVER
static final java.lang.String PROP_URIBASE_CACHE_SERVER
static final java.lang.String PROP_URIBASE_PAGE_DISPATCH_SERVER
static final java.lang.String PROP_URIBASE_DISPATCH_MANAGER
static final java.lang.String PROP_URIBASE_SYNC_SEED_DISPATCH_SERVER
static final java.lang.String PROP_URIBASE_SEED_DISPATCH_SERVER
static final java.lang.String PROP_URIBASE_SATELLITE_SERVER
static final java.lang.String LOG_NAME
Log
, Constant Field ValuesMethod Detail |
---|
void setProperties(java.util.Properties props)
Property values do not need to be unique.
This method must be called by all Assemblers before any other Assembler methods are called.
props
- The propertiesjava.net.URI assemble(Definition def) throws java.net.URISyntaxException
def
- The definition to convert to a URIjava.net.URISyntaxException
- if the definition contains illegal dataDefinition disassemble(java.net.URI uri, Definition.ContainerType ct) throws java.net.URISyntaxException
This method needs to be able to identify a URI passed to it as one of its own or as a foreign URI. If the URI is foreign, then this method must return null. If there is an error in the URI syntax, and this URI is identified as owned by the implementation, then a URISyntaxException may be thrown.
uri
- URI to disassemblect
- the type of the container that this URL is being generated for.java.net.URISyntaxException
- if there is a problem with the URI syntax.Definition
, Definition.ContainerType
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved.