com.ibm.portal.outbound.config
Interface OutboundConnectionProfile

All Superinterfaces:
Administrable
All Known Subinterfaces:
ModifiableOutboundConnectionProfile

public interface OutboundConnectionProfile
extends Administrable

This object represents a configuration profile for outbound connections.

An OutboundConnectionProfile item represents the top-level item of an outbound connection configuration. A portal system contains one global OutboundConnectionProfile items. Additionally, application scoped connection profiles may be specified. The method getApplicationScope() returns the application to which this profile belongs. The returned application scope is the context root of the webmodule in which the application resides, for that this connection profile is defined.
The following example shows code how get the global profile, and global profile, and how to access an application scoped profile.

String bannerApplicationScope = "/wps/PA_Banner_Ad";
OutboundConnectionModel model;
˙˙˙
OutboundConnectionProfile theGlobalProfile = model.getProfileLocator().findGlobalProfile();
OutboundConnectionProfile theBannerAdProfile = profiles.findScopedProfile(bannerApplicationScope);

Since:
8.5.0
See Also:
OutboundConnectionModel, OutboundConnectionProfileLocator, PolicyVariable

Method Summary
 java.lang.String getApplicationScope()
          return the scope of the application for which the configuration applies.
 boolean hasApplicationScope()
          return if this connection profile has an application scope.
 
Methods inherited from interface com.ibm.portal.outbound.config.Administrable
getName, isReadOnly
 

Method Detail

hasApplicationScope

boolean hasApplicationScope()
return if this connection profile has an application scope.

Returns:
true if this connection profile is application scoped. false if this connection profile is the global profile.

getApplicationScope

java.lang.String getApplicationScope()
return the scope of the application for which the configuration applies.

Returns:
the application scope . Returns null if this connection profile is the global profile. An example of an application scope is "/wps/PA_Banner_Ad"