com.ibm.portal.outbound.config
Interface PolicyMapping

All Superinterfaces:

Administrable

All Known Subinterfaces:

ModifiablePolicyMapping

public interface PolicyMapping
extends Administrable

The Outbound Connection configuration setting of a PolicyMapping. PolicyMapping items hold connection information that is relevant if the outbound connection is established thru the AJAX Proxy.
When an OutboundConnectionProfile object is created, a default PolicyMapping instance is automatically created. If it is intended to establish outbound HTTP connections thru the ajax proxy, a PolicyMapping item should be created that contains settings which refer the AJAX Proxy settings, such as the context path, which identifies the mapping by the context path of the Ajax Proxy being used. For example, the administrator can specify a PolicyMapping for the context path "/myproxy". policy rules that are owned by this mapping are accessible from the ajax proxy, if the remote connection is established by the ajax proxy context path "/myproxy". That is, access to outbound conections using the "/myproxy" servlet path is secured by the security settings.
Access example:


OutboundConnectionModel model;
OutboundConnectionProfile profile;
˙˙˙
PolicyMappping theDefaultMapping = model.getPolicyMappingLocator(profile).getDefaultMapping();
System.out.println ("This should also return true: "+theDefaultMapping.isDefault());


Since:

8.5.0

See Also:

OutboundConnectionModel, OutboundConnectionProfile, PolicyMappingLocator

Method Summary

java.lang.String	getContextPath() Return the context path
IterableListModel<IPFilterSetting>	getIPFilterSettings() get a list of IP filters
java.util.Map<java.lang.String,java.lang.String>	getMetaData() Return the object meta data
java.lang.String	getUrl() Return the URL pattern.
boolean	isDefault() return if the returned mapping is the default mapping.

Methods inherited from interface com.ibm.portal.outbound.config.Administrable

getName, isReadOnly

Method Detail

isDefault

boolean isDefault()

return if the returned mapping is the default mapping. Note that default policy mappings cannot be deleted.

Returns:

true if this policy mapping is the default policy mapping, false if not.

getContextPath

java.lang.String getContextPath()

Return the context path

Returns:

the context path. Never null, never empty.

getUrl

java.lang.String getUrl()

Return the URL pattern.

Returns:

the URL pattern. Never null, never empty.

getIPFilterSettings

IterableListModel<IPFilterSetting> getIPFilterSettings()

get a list of IP filters

Returns:

List a list of IP filters, or an immutable empty list if there are no IP filters.

getMetaData

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

Return the object meta data

Returns:

the meta data that are associated for this model.