com.ibm.portal.resolver.data
Interface Addressable
- All Known Subinterfaces:
- ByteDataSource, CacheControlDataSource, CachedDataSourceFactory.UncacheableValue<T>, CachedDataSourceFactory.Value<T>, CharDataSource, ContentDispositionDataSource, ContentLengthDataSource, ConvertibleDataSource, DataSource, DataSourceChecksum, EventRequest, JsonDataSource, MultipartDataSource, Operation, PocURL, ProjectContextDataSource, RedirectDataSource, RenderEventRequest, ResourceEventRequest, SafeOperation, StatusCodeDataSource, UnsafeOperation, UserContextDataSource, VaryDataSource, VirtualPortalContextDataSource, XmlDataSource
- All Known Implementing Classes:
- AbstractDataSource, AbstractStaticDataSource, DefaultDataSink, DefaultDataSource, EarlyBindingDataSource, PortletURI, ServiceHandlerNotFoundException, ServiceNotAvailableException, URINotFoundException
-
public interface Addressable
Interface that allows to retrieve the address of a piece of content.
URI and parameters should reference the canonical address of the
item.
- Since:
- 6.1.0
- Note:
This interface is designed to be implemented by clients. |
Field Summary
|
static java.util.Map<java.lang.String,java.lang.String[]> |
EMPTY_PARAMETERS
The empty parameters map, unmodifiable |
Method Summary
|
java.util.Map<java.lang.String,java.lang.String[]> |
getParameters()
Returns an potentially unmodifiable version of the parameters used to
address the object, never null, but potentially the empty
map. |
java.net.URI |
getURI()
Return the unique identifier of the object. |
EMPTY_PARAMETERS
static final java.util.Map<java.lang.String,java.lang.String[]> EMPTY_PARAMETERS
- The empty parameters map, unmodifiable
- Since:
- 7.0
getParameters
java.util.Map<java.lang.String,java.lang.String[]> getParameters()
-
Returns an potentially unmodifiable version of the parameters used to
address the object, never null, but potentially the empty
map.
The key is of type String, the values of type
String[]
- Returns:
- parameter map
getURI
java.net.URI getURI()
throws java.net.URISyntaxException
- Returns the unique identifier of the object. The URI must contain valid
scheme information and cannot be just a relative URL.
- Returns:
- URI of the object, never null.
- Throws:
- java.net.URISyntaxException - - if the URL cannot be constructed