com.highdeal.hci.http

Class HttpMessageSenderFactory

java.lang.Object

com.highdeal.hci.MessageSenderFactory

com.highdeal.hci.http.HttpMessageSenderFactory

public class HttpMessageSenderFactory
extends MessageSenderFactory

This Java class defines a factory API that enables your client applications (using the HCI technical interface) to create a generic HTTP message sender necessary for HCI communications; You can also develop a message sender dedicated to administration and connected to a dispatcher instance of the SAP CC system or develop a message sender dedicated to the communications with the updater instance of the SAP CC system.

Field Summary

Fields

Modifier and Type	Field and Description
static XMLMapping	DEFAULT_ADMIN_XML_MAPPING Returns a default XML mapping for the administration purpose; It includes both the AdminXMLMapping and the HCIMapping.
static java.lang.String	HCI_HTTP_URL The property name needed to be initialized with properties describing the HTTP URL to be connected to: "hci.http.url"

Constructor Summary

Constructors

Constructor and Description
HttpMessageSenderFactory()

Method Summary

Modifier and Type	Method and Description
MessageSender	createAdminMessageSender() Creates a new AdminMessageSender for communications via HCI to the administration services of a dispatcher instance.
MessageSender	createAdminMessageSender(java.lang.String instanceKey) Creates a new AdminMessageSender for communications via HCI and connected to the administration services of the distant SAP CC system.
MessageSender	createMessageSender() Creates a new UpdaterMessageSender for communications via HCI.
MessageSender	createSimpleMessageSender() Creates a new HttpMessageSender for communications via HCI.
java.lang.String	getHttpUrl() Returns the HTTP URL the new message senders will be connected to.
javax.net.ssl.SSLSocketFactory	getSSLSocketFactory() Gets the SSLSocketFactory used to create socket for HTTPS connections. If not set, the default factory is used.
void	init(java.util.Properties props) Initializes an HttpMessageSenderFactory with properties.
void	init(java.net.URL... dipatcherUrls) Initializes an HttpMessageSenderFactory from the list of URLs of the dispatcher instance(s) of the distant SAP CC system.
void	setHttpUrl(java.lang.String host, int port) Sets the main HTTP URL of the distant SAP CC system to which the new message senders will be connected to; The resulting URL includes the "/admin" path.
void	setHttpUrl(java.lang.String host, int port, boolean securityEnabled) Sets the main HTTP URL to which the new message senders will be connected to; The resulting URL includes the "/admin" path.
void	setSSLSocketFactory(javax.net.ssl.SSLSocketFactory sslSocketFactory) Sets the SSLSocketFactory used to create socket for HTTPS connections. If not set, the default factory is used.

Methods inherited from class com.highdeal.hci.MessageSenderFactory

newInstance, setXMLMapping

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

HCI_HTTP_URL

public static final java.lang.String HCI_HTTP_URL

The property name needed to be initialized with properties describing the HTTP URL to be connected to: "hci.http.url"

See Also:

Constant Field Values

DEFAULT_ADMIN_XML_MAPPING

public static final XMLMapping DEFAULT_ADMIN_XML_MAPPING

Returns a default XML mapping for the administration purpose; It includes both the AdminXMLMapping and the HCIMapping.

Constructor Detail

HttpMessageSenderFactory

public HttpMessageSenderFactory()

Method Detail

init

public void init(java.util.Properties props)
          throws BadConfigurationException

Initializes an HttpMessageSenderFactory with properties.

It expects the property named HCI_HTTP_URL describing the HTTP URL to which the new message senders will be connected to.

The value of this property must have the format: "http://hostname:port" where hostname is the host address of the distant SAP CC system and port, its listening communication port for HTTP protocol dedicated to HCI.

Specified by:

init in class MessageSenderFactory

Parameters:

props - The properties containing a property HCI_HTTP_URL

Throws:

BadConfigurationException - When props is null or when the property HCI_HTTP_URL does not exist

init

public void init(java.net.URL... dipatcherUrls)
          throws BadConfigurationException

Initializes an HttpMessageSenderFactory from the list of URLs of the dispatcher instance(s) of the distant SAP CC system.

Specified by:

init in class MessageSenderFactory

Parameters:

dipatcherUrls - The list of URLs of the dispatcher (with /admin path) used to initialize this factory

Throws:

BadConfigurationException - If parameters are not correct or empty

getSSLSocketFactory

public javax.net.ssl.SSLSocketFactory getSSLSocketFactory()

Gets the SSLSocketFactory used to create socket for HTTPS connections.
If not set, the default factory is used.

Returns:

The SSLSocketFactory used for HTTPS connections

setSSLSocketFactory

public void setSSLSocketFactory(javax.net.ssl.SSLSocketFactory sslSocketFactory)

Sets the SSLSocketFactory used to create socket for HTTPS connections.
If not set, the default factory is used.

Parameters:

sslSocketFactory - The SSLSocketFactory to use for HTTPS connections

getHttpUrl

public java.lang.String getHttpUrl()

Returns the HTTP URL the new message senders will be connected to.

Returns:

A string like "http://host:port" if it is initialized; null otherwise

See Also:

setHttpUrl(String, int), init(Properties)

setHttpUrl

public void setHttpUrl(java.lang.String host,
                       int port)
                throws java.lang.IllegalArgumentException

Sets the main HTTP URL of the distant SAP CC system to which the new message senders will be connected to; The resulting URL includes the "/admin" path.

• If host is null then it uses the wildcard address
• A valid value of port is a number in [1-65535]

Parameters:

host - The name of the HTTP server host

port - The communication port of the machine hosting the server instance

Throws:

java.lang.IllegalArgumentException - If port is out of range

setHttpUrl

public void setHttpUrl(java.lang.String host,
                       int port,
                       boolean securityEnabled)
                throws java.lang.IllegalArgumentException

Sets the main HTTP URL to which the new message senders will be connected to; The resulting URL includes the "/admin" path.

If host is null then it uses the wildcard address. A valid value of port is a number in [1-65535].

Parameters:

host - The hostname of a dispatcher instance of the distant SAP CC system

port - The distant port dedicated to HCI communications

securityEnabled - Specifies to use HTTPS for secured communications

Throws:

java.lang.IllegalArgumentException - If port is out of range

createAdminMessageSender

public MessageSender createAdminMessageSender(java.lang.String instanceKey)

Creates a new AdminMessageSender for communications via HCI and connected to the administration services of the distant SAP CC system.

The URL of the MessageSender is "http://dispatcher_hostname:port/admin/instanceKey"

Specified by:

createAdminMessageSender in class MessageSenderFactory

Parameters:

instanceKey - The instance identifier in the distant SAP CC system which must finally receive the administration message forwarded by a dispatcher instance of the SAP CC system

Returns:

A message sender

See Also:

setHttpUrl(String, int), init(Properties)

createAdminMessageSender

public MessageSender createAdminMessageSender()

Creates a new AdminMessageSender for communications via HCI to the administration services of a dispatcher instance.

The URL of the MessageSender is "http://dispatcher_hostname:port/admin"

Specified by:

createAdminMessageSender in class MessageSenderFactory

Returns:

A message sender

See Also:

setHttpUrl(String, int), init(Properties)

createMessageSender

public MessageSender createMessageSender()

Creates a new UpdaterMessageSender for communications via HCI.

The new message sender is connected to the initialization HTTP URL.

Specified by:

createMessageSender in class MessageSenderFactory

Returns:

A message sender

See Also:

setHttpUrl(String, int), init(Properties)

createSimpleMessageSender

public MessageSender createSimpleMessageSender()

Creates a new HttpMessageSender for communications via HCI.

The new message sender is connected to the initialization HTTP URL.

Specified by:

createSimpleMessageSender in class MessageSenderFactory

Returns:

A message sender

See Also:

setHttpUrl(String, int), init(Properties)