ch.icosys.popjava.core.combox.plugin

Class ComboxFactoryPlugin

java.lang.Object

ch.icosys.popjava.core.combox.ComboxFactory

ch.icosys.popjava.core.combox.plugin.ComboxFactoryPlugin

public class ComboxFactoryPlugin
extends ComboxFactory

This class defined the interface for new combox factory plug-in

Constructor Summary

Constructors

Constructor and Description
ComboxFactoryPlugin()

Method Summary

Modifier and Type	Method and Description
ComboxAllocate	createAllocateCombox(boolean enableUPNP) Create and allocation combox when instantiating a new remote object
Combox	createClientCombox(java.lang.String networkUUID) Create a new client combox with the given access point
ComboxServer	createServerCombox(AccessPoint accessPoint, int timeout, POPBuffer buffer, Broker broker) Create a new server combox with the given access point, buffer and broker and a connection timeout
ComboxServer	createServerCombox(AccessPoint accessPoint, POPBuffer buffer, Broker broker) Create a new server combox with the given access point, buffer and broker
java.lang.String	getComboxName() Get the combox name
boolean	isAvailable() Check if this combox is usable.
boolean	isSecure() Mark if the protocol used by this Combox is secure or not

Methods inherited from class java.lang.Object

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

Constructor Detail

ComboxFactoryPlugin

public ComboxFactoryPlugin()

Method Detail

createClientCombox

public Combox createClientCombox(java.lang.String networkUUID)

Description copied from class: ComboxFactory

Create a new client combox with the given access point

Specified by:

createClientCombox in class ComboxFactory

Parameters:

networkUUID - The network we are using

Returns:

The combox created

createServerCombox

public ComboxServer createServerCombox(AccessPoint accessPoint,
                                       POPBuffer buffer,
                                       Broker broker)

Description copied from class: ComboxFactory

Create a new server combox with the given access point, buffer and broker

Specified by:

createServerCombox in class ComboxFactory

Parameters:

accessPoint - The access point for the server

buffer - The buffer for sending and receiving

broker - The broker associated with this combox

Returns:

The combox server created

createServerCombox

public ComboxServer createServerCombox(AccessPoint accessPoint,
                                       int timeout,
                                       POPBuffer buffer,
                                       Broker broker)

Description copied from class: ComboxFactory

Create a new server combox with the given access point, buffer and broker and a connection timeout

Specified by:

createServerCombox in class ComboxFactory

Parameters:

accessPoint - The access point for the server

timeout - The connection timeout

buffer - The buffer for sending and receiving

broker - The broker associated with this combox

Returns:

The combox server created

getComboxName

public java.lang.String getComboxName()

Description copied from class: ComboxFactory

Get the combox name

Specified by:

getComboxName in class ComboxFactory

Returns:

name of the combox

createAllocateCombox

public ComboxAllocate createAllocateCombox(boolean enableUPNP)

Description copied from class: ComboxFactory

Create and allocation combox when instantiating a new remote object

Specified by:

createAllocateCombox in class ComboxFactory

Returns:

the object which way for a broker connection

isAvailable

public boolean isAvailable()

Description copied from class: ComboxFactory

Check if this combox is usable. When overriding call super.isAvailable to appy the white/black lists. NB: If an item is in both white and black lists, the blacklist will take precedence Expression applied: (a V b) Λ ¬c a = whitelist is empty b = is in whitelist c = is in blacklist Truth table: a b c (a V b) Λ ¬c T T T - T T F - T F T F : blacklist T F F T : no restrictions F T T F : blacklist take precedence F T F T : whitelist F F T F : not in whitelist + blacklist F F F F : not in whitelist

Overrides:

isAvailable in class ComboxFactory

Returns:

true if it's usable

isSecure

public boolean isSecure()

Description copied from class: ComboxFactory

Mark if the protocol used by this Combox is secure or not

Specified by:

isSecure in class ComboxFactory

Returns:

true if the factory is secure