com.ibm.portal.outbound.service
Interface OutboundConnectionServiceHome


public interface OutboundConnectionServiceHome

The home for the Outbound Connection API. Code example: javax.naming.Context ctx = new javax.naming.InitialContext(); OutboundConnectionServiceHome home = (OutboundConnectionServiceHome) ctx.lookup("portal:service/model/OutboundConnectionService"); NOTE: This API may only be used in the scope of an HTTP request in WebSphere Portal, i.e. within a theme. The API can not be invoked directly by a custom servlet.

Since:
8.5.0
See Also:
OutboundConnectionService

Field Summary
static java.lang.String JNDI_NAME
           
 
Method Summary
 OutboundConnectionService getOutboundConnectionService(ApplicationContextBean context)
          Create an outbound connection service, using an application context object.
 OutboundConnectionService getOutboundConnectionService(HttpServletRequest aRequest, HttpServletResponse aResponse)
          Create an outbound connection service, using the default policy mapping.
 OutboundConnectionService getOutboundConnectionService(HttpServletRequest aRequest, HttpServletResponse aResponse, java.util.Map<java.lang.String,java.lang.String> variables)
          Create an outbound connection service, using the default policy mapping.
 OutboundConnectionService getOutboundConnectionService(HttpServletRequest aRequest, HttpServletResponse aResponse, java.lang.String mappingContext)
          Create an outbound connection service, using a specified policy mapping.
 OutboundConnectionService getOutboundConnectionService(HttpServletRequest aRequest, HttpServletResponse aResponse, java.lang.String mappingContext, java.util.Map<java.lang.String,java.lang.String> variables)
          Create an outbound connection service, using a specified policy mapping.
 OutboundConnectionService getOutboundConnectionService(PortletRequest aRequest, PortletResponse aResponse)
          Create an outbound connection service, using the default policy mapping.
 OutboundConnectionService getOutboundConnectionService(PortletRequest aRequest, PortletResponse aResponse, java.util.Map<java.lang.String,java.lang.String> variables)
          Create an outbound connection service, using the default policy mapping.
 OutboundConnectionService getOutboundConnectionService(PortletRequest aRequest, PortletResponse aResponse, java.lang.String mappingContext)
          Create an outbound connection service, using a specified policy mapping.
 OutboundConnectionService getOutboundConnectionService(PortletRequest aRequest, PortletResponse aResponse, java.lang.String mappingContext, java.util.Map<java.lang.String,java.lang.String> variables)
          Create an outbound connection service, using a specified policy mapping.
 

Field Detail

JNDI_NAME

static final java.lang.String JNDI_NAME
Since:
8.0.5
See Also:
Constant Field Values
Method Detail

getOutboundConnectionService

OutboundConnectionService getOutboundConnectionService(PortletRequest aRequest,
                                                       PortletResponse aResponse,
                                                       java.lang.String mappingContext)
                                                       throws OutboundConnectionServiceException
Create an outbound connection service, using a specified policy mapping.

Parameters:
aRequest -
aResponse -
mappingContext - The mapping that should be used. An empty String or null means to use the default mapping.
Returns:
The outbound connection service. Never null.
Throws:
OutboundConnectionServiceException

getOutboundConnectionService

OutboundConnectionService getOutboundConnectionService(PortletRequest aRequest,
                                                       PortletResponse aResponse)
                                                       throws OutboundConnectionServiceException
Create an outbound connection service, using the default policy mapping.

Parameters:
aRequest -
aResponse -
Returns:
The outbound connection service. Never null.
Throws:
OutboundConnectionServiceException

getOutboundConnectionService

OutboundConnectionService getOutboundConnectionService(PortletRequest aRequest,
                                                       PortletResponse aResponse,
                                                       java.lang.String mappingContext,
                                                       java.util.Map<java.lang.String,java.lang.String> variables)
                                                       throws OutboundConnectionServiceException
Create an outbound connection service, using a specified policy mapping. Set variables

Parameters:
aRequest -
aResponse -
a - set of override variables.
mappingContext - The mapping that should be used. An empty String or null means to use the default mapping.
Returns:
The outbound connection service. Never null.
Throws:
OutboundConnectionServiceException

getOutboundConnectionService

OutboundConnectionService getOutboundConnectionService(PortletRequest aRequest,
                                                       PortletResponse aResponse,
                                                       java.util.Map<java.lang.String,java.lang.String> variables)
                                                       throws OutboundConnectionServiceException
Create an outbound connection service, using the default policy mapping.

Parameters:
aRequest -
aResponse -
Returns:
The outbound connection service. Never null.
Throws:
OutboundConnectionServiceException

getOutboundConnectionService

OutboundConnectionService getOutboundConnectionService(HttpServletRequest aRequest,
                                                       HttpServletResponse aResponse,
                                                       java.lang.String mappingContext)
                                                       throws OutboundConnectionServiceException
Create an outbound connection service, using a specified policy mapping.

Parameters:
aRequest -
aResponse -
a - set of override variables.
mappingContext - The mapping that should be used. An empty String or null means to use the default mapping.
Returns:
The outbound connection service. Never null.
Throws:
OutboundConnectionServiceException

getOutboundConnectionService

OutboundConnectionService getOutboundConnectionService(HttpServletRequest aRequest,
                                                       HttpServletResponse aResponse)
                                                       throws OutboundConnectionServiceException
Create an outbound connection service, using the default policy mapping.

Parameters:
aRequest -
aResponse -
Returns:
The outbound connection service. Never null.
Throws:
OutboundConnectionServiceException

getOutboundConnectionService

OutboundConnectionService getOutboundConnectionService(HttpServletRequest aRequest,
                                                       HttpServletResponse aResponse,
                                                       java.lang.String mappingContext,
                                                       java.util.Map<java.lang.String,java.lang.String> variables)
                                                       throws OutboundConnectionServiceException
Create an outbound connection service, using a specified policy mapping.

Parameters:
aRequest -
aResponse -
mappingContext - The mapping that should be used. An empty String or null means to use the default mapping.
Returns:
The outbound connection service. Never null.
Throws:
OutboundConnectionServiceException

getOutboundConnectionService

OutboundConnectionService getOutboundConnectionService(HttpServletRequest aRequest,
                                                       HttpServletResponse aResponse,
                                                       java.util.Map<java.lang.String,java.lang.String> variables)
                                                       throws OutboundConnectionServiceException
Create an outbound connection service, using the default policy mapping.

Parameters:
aRequest -
aResponse -
Returns:
The outbound connection service. Never null.
Throws:
OutboundConnectionServiceException

getOutboundConnectionService

OutboundConnectionService getOutboundConnectionService(ApplicationContextBean context)
                                                       throws OutboundConnectionServiceException
Create an outbound connection service, using an application context object.

Parameters:
context - the application context.
Returns:
The outbound connection service. Never null.
Throws:
OutboundConnectionServiceException