com.adaptris.core.fax.interfax

Class InterfaxProducer

java.lang.Object

com.adaptris.core.AdaptrisMessageWorkerImp

com.adaptris.core.AdaptrisMessageProducerImp

com.adaptris.core.ProduceOnlyProducerImp

com.adaptris.core.fax.interfax.InterfaxProducer

All Implemented Interfaces:

AdaptrisComponent, AdaptrisMessageProducer, AdaptrisMessageSender, AdaptrisMessageWorker, ComponentLifecycle, ComponentLifecycleExtension, LicensedComponent, MessageEventGenerator

@ComponentProfile(summary="Send a fax using the Interfax service",
                  tag="producer,fax",
                  recommended=com.adaptris.core.NullConnection.class)
public class InterfaxProducer
extends ProduceOnlyProducerImp
implements LicensedComponent

Implementation of AdaptrisMessageProducer which sends faxes using Interfax.

In the adapter configuration file this class is aliased as interfax-producer which is the preferred alternative to the fully qualified classname when building your configuration.

License Required: STANDARD

Field Summary

Fields inherited from class com.adaptris.core.AdaptrisMessageWorkerImp

log

Fields inherited from interface com.adaptris.core.MessageEventGenerator

CONFIRMATION_ID_KEY

Constructor Summary

Constructors

Constructor and Description
InterfaxProducer() Creates a new instance.
InterfaxProducer(ProduceDestination d)

Method Summary

Modifier and Type	Method and Description
void	close()
java.lang.String	getPassword() Returns the password to use.
ResponseHandler	getResponseHandler() Returns the ResponseHandler to use.
java.lang.String	getServiceName() Return the service name.
java.lang.String	getServiceUrl() Returns the URL of the service.
java.lang.String	getTransmissionType() Returns the transmission type, e.g.
java.lang.String	getUserName() Returns the user name for the fax service.
void	init()
boolean	isEnabled(License license)
void	prepare()
void	produce(AdaptrisMessage msg, ProduceDestination destination)
void	setPassword(java.lang.String s) Sets the password to use.
void	setResponseHandler(ResponseHandler handler) Sets the ResponseHandler to use.
void	setServiceName(java.lang.String s) Sets the service name, e.g.
void	setServiceUrl(java.lang.String s) Sets the URL of the service.
void	setTransmissionType(java.lang.String s) Sets the transmission type, e.g.
void	setUserName(java.lang.String s) Sets the user name for the fax service.
void	start()
void	stop()
java.lang.String	toString()

Methods inherited from class com.adaptris.core.ProduceOnlyProducerImp

produce, request, request, request, request

Methods inherited from class com.adaptris.core.AdaptrisMessageProducerImp

getDestination, setDestination

Methods inherited from class com.adaptris.core.AdaptrisMessageWorkerImp

createName, createQualifier, decode, encode, getEncoder, getIsTrackingEndpoint, getMessageFactory, getUniqueId, handleConnectionException, isTrackingEndpoint, registerConnection, registerEncoderMessageFactory, retrieveConnection, setEncoder, setIsTrackingEndpoint, setMessageFactory, setUniqueId, withMessageFactory

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.adaptris.core.AdaptrisMessageWorker

decode, encode, getEncoder, getMessageFactory, handleConnectionException, registerConnection, retrieveConnection, setEncoder, setMessageFactory

Methods inherited from interface com.adaptris.core.AdaptrisComponent

getUniqueId

Methods inherited from interface com.adaptris.core.MessageEventGenerator

createName, createQualifier, isTrackingEndpoint

Constructor Detail

InterfaxProducer

public InterfaxProducer()

Creates a new instance. Defaults are URL http://ws.interfax.net/DFS.asmx, service name SendCharFax, type TXT and NullResponseHandler.

InterfaxProducer

public InterfaxProducer(ProduceDestination d)

Method Detail

prepare

public void prepare()
             throws CoreException

Specified by:

prepare in interface ComponentLifecycleExtension

Throws:

CoreException

isEnabled

public boolean isEnabled(License license)

Specified by:

isEnabled in interface LicensedComponent

init

public void init()
          throws CoreException

Specified by:

init in interface ComponentLifecycle

Throws:

CoreException

See Also:

ComponentLifecycle.init()

start

public void start()
           throws CoreException

Specified by:

start in interface ComponentLifecycle

Throws:

CoreException

See Also:

ComponentLifecycle.start()

stop

public void stop()

Specified by:

stop in interface ComponentLifecycle

See Also:

ComponentLifecycle.stop()

close

public void close()

Specified by:

close in interface ComponentLifecycle

See Also:

ComponentLifecycle.close()

produce

public void produce(AdaptrisMessage msg,
                    ProduceDestination destination)
             throws ProduceException

Specified by:

produce in interface AdaptrisMessageSender

Throws:

ProduceException

See Also:

AdaptrisMessageSender.produce(AdaptrisMessage, ProduceDestination)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

See Also:

Object.toString()

setPassword

public void setPassword(java.lang.String s)

Sets the password to use. May not be null.

In additional to plain text passwords, the passwords can also be encoded using the appropriate Password

Parameters:

s - the password to use

getPassword

public java.lang.String getPassword()

Returns the password to use.

Returns:

the password to use

setTransmissionType

public void setTransmissionType(java.lang.String s)

Sets the transmission type, e.g. TXT, HTML. May not be null.

Parameters:

s - the transmission type

getTransmissionType

public java.lang.String getTransmissionType()

Returns the transmission type, e.g. TXT, HTML.

Returns:

the transmission type

setUserName

public void setUserName(java.lang.String s)

Sets the user name for the fax service. May not be null.

Parameters:

s - the user name for the fax service

getUserName

public java.lang.String getUserName()

Returns the user name for the fax service.

Returns:

the user name for the fax service

setServiceName

public void setServiceName(java.lang.String s)

Sets the service name, e.g. SendCharFax. May not be null.

Parameters:

s - the service name

getServiceName

public java.lang.String getServiceName()

Return the service name.

Returns:

the service name

setServiceUrl

public void setServiceUrl(java.lang.String s)

Sets the URL of the service.

Parameters:

s - the URL of the service

getServiceUrl

public java.lang.String getServiceUrl()

Returns the URL of the service.

Returns:

the URL of the service

setResponseHandler

public void setResponseHandler(ResponseHandler handler)

Sets the ResponseHandler to use.

Parameters:

handler - the ResponseHandler to use

getResponseHandler

public ResponseHandler getResponseHandler()

Returns the ResponseHandler to use.

Returns:

the ResponseHandler to use