Tree PREV CLASS NEXT CLASS SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD com.ibm.portal.outbound.config
Interface OutboundConnectionProfileLocator
- All Superinterfaces:
- AdministrableLocator<OutboundConnectionProfile>
public interface OutboundConnectionProfileLocator- extends AdministrableLocator<OutboundConnectionProfile>
A locator for OutboundConnectionProfile configuration items. This interface provides methods to get outbound HTTP connection profiles. There are three types of profiles:
- the system profile
- the global profile
- application scoped profiles
Coding example:
OutboundConnectionModel model;
˙˙˙
OutboundConnectionProfileLocator availableProfiles = model.OutboundConnectionProfileLocator();
- Since:
- 8.5.0
- See Also:
- OutboundConnectionModel, OutboundConnectionProfile
Method Summary OutboundConnectionProfile findGlobalProfile()
find and return the global profile.OutboundConnectionProfile findRootProfile(OutboundConnectionProfile vpScopedProfile)
find and return the profile from the root Virtual Portal.OutboundConnectionProfile findScopedProfile(java.lang.String scope)
Find and return the application scoped profile.OutboundConnectionProfile findSystemProfile()
find and return the system profile.
Methods inherited from interface com.ibm.portal.outbound.config.AdministrableLocator collectAllMatching, findByName, listAll
Method Detail findScopedProfile
OutboundConnectionProfile findScopedProfile(java.lang.String scope)
- Find and return the application scoped profile.
- Parameters:
- scope - The application scope. This is the URL context of the application (for example: "/wps/PA_MyApplication")
- Returns:
- The connection profile for this application. The method returns null if there is no application-scoped profile for the application.
findGlobalProfile
OutboundConnectionProfile findGlobalProfile()
- find and return the global profile. The method returns the global profile of the current virtual portal.
- Returns:
- The global profile. The method returns null if there is no global profile for the application.
findRootProfile
OutboundConnectionProfile findRootProfile(OutboundConnectionProfile vpScopedProfile)
- find and return the profile from the root Virtual Portal.
- Returns:
- The profile which is not scoped to the current virtual portal. The method returns null if there is no profile for the root virtual portal, or if vpScopedProfile is not scoped to a virtual portal.
findSystemProfile
OutboundConnectionProfile findSystemProfile()
- find and return the system profile.
- Returns:
- The system profile. Never null.
Tree PREV CLASS NEXT CLASS SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD