com.wm.app.tn.delivery
Class DeliveryService

java.lang.Object
  com.wm.app.tn.util.TNFixedData
      com.wm.app.tn.delivery.DeliveryService

All Implemented Interfaces:

com.wm.data.IData, java.lang.Cloneable

public class DeliveryService
extends TNFixedData

This class holds the information for a B2B service to be used by the reliabe delivery engine to deliver a document.

Nested Class Summary

Nested classes/interfaces inherited from class com.wm.app.tn.util.TNFixedData

TNFixedData.TreeCursor

Field Summary

static int	TYPE_ALL
static int	TYPE_IMMEDIATE
static int	TYPE_SCHEDULED

Constructor Summary

DeliveryService()
Default constructor required for subclasses of TNFixedData.

DeliveryService(java.lang.String name, java.lang.String ifc, java.lang.String svc)
This constructor can be used for "local" services

DeliveryService(java.lang.String name, java.lang.String ifc, java.lang.String svc, boolean scheduled)
This constructor can be used for "local" scheduled services

DeliveryService(java.lang.String name, java.lang.String location, java.lang.String user, java.lang.String password, java.lang.String ifc, java.lang.String svc)
Create a new DeliveryService.

Method Summary

static com.wm.data.IData	create() Required for subclasses of TNFixedData
java.lang.String	getIfc()
java.lang.String	getLocation()
java.lang.String	getName()
java.lang.String	getPassword()
java.lang.String	getSvc()
java.lang.String	getUser()
boolean	isLocal()
boolean	isScheduledDelivery()
void	setIfc(java.lang.String ifc)
void	setLocal(boolean local) Mark the whether or not the service to be run locally
void	setLocation(java.lang.String location)
void	setName(java.lang.String name) Set the unique name used for this delivery service.
void	setPassword(java.lang.String password) Set the password to be used for invoking the delivery service.
void	setScheduledDelivery(boolean scheduled) Used to indicate whether the the service performs scheduled delivery
void	setSvc(java.lang.String svc) Set the B2B service for the delivery service.
void	setUser(java.lang.String user) Set the user name to be used for invoking the delivery service.
java.lang.String	toString() Default toString implementation returns class name followed by contents.

Methods inherited from class com.wm.app.tn.util.TNFixedData

clone, dataSize, get, get, getCursor, getHashCursor, getIndexCursor, getKey, getSharedCursor, getTreeCursor, indexOf, merge, set, set

Methods inherited from class java.lang.Object

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

Field Detail

TYPE_SCHEDULED

public static final int TYPE_SCHEDULED

See Also:

Constant Field Values

TYPE_IMMEDIATE

public static final int TYPE_IMMEDIATE

See Also:

Constant Field Values

TYPE_ALL

public static final int TYPE_ALL

See Also:

Constant Field Values

Constructor Detail

DeliveryService

public DeliveryService()

Default constructor required for subclasses of TNFixedData.

DeliveryService

public DeliveryService(java.lang.String name,
                       java.lang.String location,
                       java.lang.String user,
                       java.lang.String password,
                       java.lang.String ifc,
                       java.lang.String svc)

Create a new DeliveryService. If location begins with "localhost" or null this will be set to run locally.

Parameters:

name - delivery service name (should be unique)

location - host:port to invoke service on

user - user name

password - user password

ifc - interface name

svc - service name

DeliveryService

public DeliveryService(java.lang.String name,
                       java.lang.String ifc,
                       java.lang.String svc)

This constructor can be used for "local" services

Parameters:

name - delivery service name (should be unique)

ifc - interface

svc - service

DeliveryService

public DeliveryService(java.lang.String name,
                       java.lang.String ifc,
                       java.lang.String svc,
                       boolean scheduled)

This constructor can be used for "local" scheduled services

Parameters:

name - delivery service name (should be unique)

ifc - interface

svc - service

scheduled - performs scheduled delivery?

Method Detail

create

public static com.wm.data.IData create()

Required for subclasses of TNFixedData

getIfc

public java.lang.String getIfc()

Returns:

the B2B interface name

getSvc

public java.lang.String getSvc()

Returns:

the B2B service name

getLocation

public java.lang.String getLocation()

Returns:

the location [host]:[port]

getName

public java.lang.String getName()

Returns:

the delivery service name

getPassword

public java.lang.String getPassword()

Returns:

the user password

getUser

public java.lang.String getUser()

Returns:

the user

isLocal

public boolean isLocal()

Returns:

whether or not the service is to be run locally

isScheduledDelivery

public boolean isScheduledDelivery()

Returns:

whether or not this is a scheduled delivery service

setIfc

public void setIfc(java.lang.String ifc)

Parameters:

ifc -

setLocal

public void setLocal(boolean local)

Mark the whether or not the service to be run locally

Parameters:

local - true if a local service

setLocation

public void setLocation(java.lang.String location)

Parameters:

location - [host]:[port] to invoke service on

setName

public void setName(java.lang.String name)

Set the unique name used for this delivery service.

Parameters:

name -

setPassword

public void setPassword(java.lang.String password)

Set the password to be used for invoking the delivery service.

Parameters:

password -

setSvc

public void setSvc(java.lang.String svc)

Set the B2B service for the delivery service.

Parameters:

svc -

setScheduledDelivery

public void setScheduledDelivery(boolean scheduled)

Used to indicate whether the the service performs scheduled delivery

Parameters:

svc -

setUser

public void setUser(java.lang.String user)

Set the user name to be used for invoking the delivery service.

Parameters:

user -

toString

public java.lang.String toString()

Description copied from class: TNFixedData

Default toString implementation returns class name followed by contents.

Overrides:

toString in class TNFixedData

Returns:

a String representation of a DeliveryService