org.tiian.flom

Class FlomHandle

java.lang.Object

org.tiian.flom.FlomHandle

public class FlomHandle
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
FlomHandle() Create a new object calling the native interface

Method Summary

Methods

Modifier and Type	Method and Description
protected void	finalize() Release native object if finalization is executed and the program forgot to call release method
void	free() Explicitly free the native object allocated by JNI wrapper
int	getDiscoveryAttempts() Get the maximum number of attempts that will be tryed during auto-discovery phase using UDP/IP multicast (see getMulticastAddress, getMulticastPort).
int	getDiscoveryTimeout() Get the number of milliseconds between two consecutive attempts that will be tryed during auto-discovery phase using UDP/IP multicast (see getMulticastAddress, getMulticastPort).
int	getDiscoveryTtl() Get the UDP/IP multicast TTL parameter used during auto-discovery phase; for a definition of the parameter, see http://www.tldp.org/HOWTO/Multicast-HOWTO-2.html .
java.lang.String	getLockedElement() Get the name of the locked element if the resource is of type set; this method throws an exception if the name of the locked element is not available
int	getLockMode() Get lock mode property: how a simple or hierarchical resource will be locked when method lock is called; FLoM supports the same lock mode semantic proposed by DLM, see http://en.wikipedia.org/wiki/Distributed_lock_manager#Lock_modes for a detailed explanation .
java.lang.String	getMulticastAddress() Get the multicast address: the IP address (or a network name that the system can resolve) of the IP multicast group that must be contacted to reach FLoM daemon (server) using UDP/IP; see also getMulticastPort.
int	getMulticastPort() Get the UDP/IP multicast port that must be used to contact the FLoM daemon (server) using UDP/IP; see also getMulticastAddress.
java.lang.String	getNetworkInterface() Get the network interface that must be used for IPv6 link local addresses The current value can be altered using method setNetworkInterface.
boolean	getResourceCreate() Get the UDP/IP multicast port that must be used to contact the FLoM daemon (server) using UDP/IP; see also getMulticastAddress.
int	getResourceIdleLifespan() Get "resource idle lifespan" property: it specifies how many milliseconds a resource will be kept after the last locker released it; the expiration is necessary to avoid useless resource allocation.
java.lang.String	getResourceName() Get the resource name: the name of the resource that can be locked and unlocked using lock and unlock methods.
int	getResourceQuantity() Get "resource quantity" property: the number of units that will be locked and unlocked using lock and unlock methods.
int	getResourceTimeout() Get "resource timeout" property: how long a lock operation (see lock) will wait if the resource is locked by another requester.
java.lang.String	getSocketName() Get the socket name: the AF_LOCAL/AF_UNIX socket name that must be used to contact a local FLoM daemon (server).
java.lang.String	getTlsCaCertificate() Get the TLS CA certificate file name.
java.lang.String	getTlsCertificate() Get the TLS certificate file name.
boolean	getTlsCheckPeerId() Get the TLS check peer ID flag value.
java.lang.String	getTlsPrivateKey() Get the TLS private key file name.
java.lang.String	getTraceFilename() Get the trace filename: the name (absolute or relative path) used by libflom (FLoM client library) to record trace messages.
java.lang.String	getUnicastAddress() Get the unicast address: the IP address (or a network name that the system can resolve) of the host that must be contacted to reach FLoM daemon (server) using TCP/IP; see also getUnicastPort.
int	getUnicastPort() Get the TCP/IP unicast port that must be used to contact the FLoM daemon (server) using TCP/IP; see also getUnicastAddress.
void	lock() Lock the (logical) resource linked to this handle; the resource MUST be unlocked using method unlock (or unlockRollback) when the lock condition is no more necessary.
int	setDiscoveryAttempts(int value) Set the maximum number of attempts that will be tryed during auto-discovery phase using UDP/IP multicast (see setMulticastAddress, setMulticastPort).
int	setDiscoveryTimeout(int value) Set the number of milliseconds between two consecutive attempts that will be tryed during auto-discovery phase using UDP/IP multicast (see setMulticastAddress, setMulticastPort).
int	setDiscoveryTtl(int value) Set the UDP/IP multicast TTL parameter used during auto-discovery phase; for a definition of the parameter, see http://www.tldp.org/HOWTO/Multicast-HOWTO-2.html .
int	setLockMode(int value) Set lock mode property: how a simple or hierarchical resource will be locked when method lock is called; FLoM supports the same lock mode semantic proposed by DLM, see http://en.wikipedia.org/wiki/Distributed_lock_manager#Lock_modes for a detailed explanation .
int	setMulticastAddress(java.lang.String value) Set the multicast address: the IP address (or a network name that the system can resolve) of the IP multicast group that must be contacted to reach FLoM daemon (server) using UDP/IP; see also setMulticastPort.
int	setMulticastPort(int value) Set the UDP/IP multicast port that must be used to contact the FLoM daemon (server) using UDP/IP; see also setMulticastAddress.
int	setNetworkInterface(java.lang.String value) Set the network interface that must be used for IPv6 link local addresses The current value can be inspected using method getNetworkInterface.
int	setResourceCreate(boolean value) Set "resource create" boolean property: it specifies if method lock can create a new resource when the specified one is not defined.
int	setResourceIdleLifespan(int value) Set "resource idle lifespan" property: it specifies how many milliseconds a resource will be kept after the last locker released it; the expiration is necessary to avoid useless resource allocation.
int	setResourceName(java.lang.String value) Set the resource name: the name of the resource that can be locked and unlocked using lock and unlock methods.
int	setResourceQuantity(int value) Set "resource quantity" property: the number of units that will be locked and unlocked using lock and unlock methods.
int	setResourceTimeout(int value) Set "resource timeout" property: how long a lock operation (see lock) will wait if the resource is locked by another requester.
int	setSocketName(java.lang.String value) Set the socket name: the AF_LOCAL/AF_UNIX socket name that must be used to contact a local FLoM daemon (server).
int	setTlsCaCertificate(java.lang.String value) Set the TLS CA certificate file name.
int	setTlsCertificate(java.lang.String value) Set the TLS certificate file name.
int	setTlsCheckPeerId(boolean value) Set "TLS check peer ID" boolean property: it specifies if this node must check the unique ID presented by the remote peer.
int	setTlsPrivateKey(java.lang.String value) Set the TLS CA private key file name.
int	setTraceFilename(java.lang.String value) Set the trace filename: the name (absolute or relative path) used by libflom (FLoM client library) to record trace messages.
int	setUnicastAddress(java.lang.String value) Set the unicast address: the IP address (or a network name that the system can resolve) of the host that must be contacted to reach FLoM daemon (server) using TCP/IP; see also setUnicastPort.
int	setUnicastPort(int value) Set the TCP/IP unicast port that must be used to contact the FLoM daemon (server) using TCP/IP; see also setUnicastAddress.
void	unlock() Unlock the (logical) resource linked to this handle; the resource MUST be previously locked using method lock
void	unlockRollback() Unlock the (logical) resource linked to this handle and rollback the transactiona resource state; the resource MUST be previously locked using method lock

Methods inherited from class java.lang.Object

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

Constructor Detail

FlomHandle

public FlomHandle()
           throws FlomException

Create a new object calling the native interface

Throws:

FlomException - if the underlying native C function returns an error condition

Method Detail

free

public void free()

Explicitly free the native object allocated by JNI wrapper

finalize

protected void finalize()

Release native object if finalization is executed and the program forgot to call release method

Overrides:

finalize in class java.lang.Object

lock

public void lock()
          throws FlomException

Lock the (logical) resource linked to this handle; the resource MUST be unlocked using method unlock (or unlockRollback) when the lock condition is no more necessary.

Throws:

FlomException - if the underlying native C function returns an error condition

unlock

public void unlock()
            throws FlomException

Unlock the (logical) resource linked to this handle; the resource MUST be previously locked using method lock

Throws:

FlomException - if the underlying native C function returns an error condition

unlockRollback

public void unlockRollback()
                    throws FlomException

Unlock the (logical) resource linked to this handle and rollback the transactiona resource state; the resource MUST be previously locked using method lock

Throws:

FlomException - if the underlying native C function returns an error condition

getLockedElement

public java.lang.String getLockedElement()
                                  throws FlomException

Get the name of the locked element if the resource is of type set; this method throws an exception if the name of the locked element is not available

Returns:

the current value

Throws:

FlomException - if the underlying native C function returns an error condition

getDiscoveryAttempts

public int getDiscoveryAttempts()
                         throws FlomException

Get the maximum number of attempts that will be tryed during auto-discovery phase using UDP/IP multicast (see getMulticastAddress, getMulticastPort). The current value can be altered using method setDiscoveryAttempts

Returns:

the current value

Throws:

FlomException - if the underlying native C function returns an error condition

setDiscoveryAttempts

public int setDiscoveryAttempts(int value)
                         throws FlomException

Set the maximum number of attempts that will be tryed during auto-discovery phase using UDP/IP multicast (see setMulticastAddress, setMulticastPort). The current value can be inspected using method getDiscoveryAttempts

Parameters:

value - (Input): the new value

Returns:

a reason code that can be checked to be sure the property was changed by the setter method

Throws:

FlomException - if the underlying native C function returns an error condition

getDiscoveryTimeout

public int getDiscoveryTimeout()
                        throws FlomException

Get the number of milliseconds between two consecutive attempts that will be tryed during auto-discovery phase using UDP/IP multicast (see getMulticastAddress, getMulticastPort). The current value can be altered using method setDiscoveryTimeout

Returns:

the current value

Throws:

FlomException - if the underlying native C function returns an error condition

setDiscoveryTimeout

public int setDiscoveryTimeout(int value)
                        throws FlomException

Set the number of milliseconds between two consecutive attempts that will be tryed during auto-discovery phase using UDP/IP multicast (see setMulticastAddress, setMulticastPort). The current value can be inspected using method getDiscoveryTtl.

Parameters:

value - (Input): the new value

Returns:

a reason code that can be checked to be sure the property was changed by the setter method

Throws:

FlomException - if the underlying native C function returns an error condition

getDiscoveryTtl

public int getDiscoveryTtl()
                    throws FlomException

Get the UDP/IP multicast TTL parameter used during auto-discovery phase; for a definition of the parameter, see http://www.tldp.org/HOWTO/Multicast-HOWTO-2.html . The current value can be altered using method setDiscoveryTtl

Returns:

the current value

Throws:

FlomException - if the underlying native C function returns an error condition

setDiscoveryTtl

public int setDiscoveryTtl(int value)
                    throws FlomException

Set the UDP/IP multicast TTL parameter used during auto-discovery phase; for a definition of the parameter, see http://www.tldp.org/HOWTO/Multicast-HOWTO-2.html . The current value can be inspected using method getDiscoveryTtl.

Parameters:

value - (Input): the new value

Returns:

a reason code that can be checked to be sure the property was changed by the setter method

Throws:

FlomException - if the underlying native C function returns an error condition

getLockMode

public int getLockMode()
                throws FlomException

Get lock mode property: how a simple or hierarchical resource will be locked when method lock is called; FLoM supports the same lock mode semantic proposed by DLM, see http://en.wikipedia.org/wiki/Distributed_lock_manager#Lock_modes for a detailed explanation . The current value can be altered using method setLockMode. The available lock modes are described by class FlomLockModes

Returns:

the current value

Throws:

FlomException - if the underlying native C function returns an error condition

setLockMode

public int setLockMode(int value)
                throws FlomException

Set lock mode property: how a simple or hierarchical resource will be locked when method lock is called; FLoM supports the same lock mode semantic proposed by DLM, see http://en.wikipedia.org/wiki/Distributed_lock_manager#Lock_modes for a detailed explanation . The current value can be inspected using method getLockMode

Parameters:

value - (Input): the new value The available lock modes are described by class FlomLockModes

Returns:

a reason code that can be checked to be sure the property was changed by the setter method

Throws:

FlomException - if the underlying native C function returns an error condition

getMulticastAddress

public java.lang.String getMulticastAddress()
                                     throws FlomException

Get the multicast address: the IP address (or a network name that the system can resolve) of the IP multicast group that must be contacted to reach FLoM daemon (server) using UDP/IP; see also getMulticastPort. The current value can be altered using method setMulticastAddress.

Returns:

the current value

Throws:

FlomException - if the underlying native C function returns an error condition

setMulticastAddress

public int setMulticastAddress(java.lang.String value)
                        throws FlomException

Set the multicast address: the IP address (or a network name that the system can resolve) of the IP multicast group that must be contacted to reach FLoM daemon (server) using UDP/IP; see also setMulticastPort. The current value can be inspected using method getMulticastAddress.

Parameters:

value - (Input): the new value

Returns:

a reason code that can be checked to be sure the property was changed by the setter method

Throws:

FlomException - if the underlying native C function returns an error condition

getMulticastPort

public int getMulticastPort()
                     throws FlomException

Get the UDP/IP multicast port that must be used to contact the FLoM daemon (server) using UDP/IP; see also getMulticastAddress. The current value can be altered using method setMulticastPort.

Returns:

the current value

Throws:

FlomException - if the underlying native C function returns an error condition

setMulticastPort

public int setMulticastPort(int value)
                     throws FlomException

Set the UDP/IP multicast port that must be used to contact the FLoM daemon (server) using UDP/IP; see also setMulticastAddress. The current value can be inspected using method getMulticastPort.

Parameters:

value - (Input): the new value

Returns:

a reason code that can be checked to be sure the property was changed by the setter method

Throws:

FlomException - if the underlying native C function returns an error condition

getNetworkInterface

public java.lang.String getNetworkInterface()
                                     throws FlomException

Get the network interface that must be used for IPv6 link local addresses The current value can be altered using method setNetworkInterface.

Returns:

the current value

Throws:

FlomException - if the underlying native C function returns an error condition

setNetworkInterface

public int setNetworkInterface(java.lang.String value)
                        throws FlomException

Set the network interface that must be used for IPv6 link local addresses The current value can be inspected using method getNetworkInterface.

Parameters:

value - (Input): the new value

Returns:

a reason code that can be checked to be sure the property was changed by the setter method

Throws:

FlomException - if the underlying native C function returns an error condition

getResourceCreate

public boolean getResourceCreate()
                          throws FlomException

Get the UDP/IP multicast port that must be used to contact the FLoM daemon (server) using UDP/IP; see also getMulticastAddress. The current value can be altered using method setResourceCreate.

Returns:

the current value

Throws:

FlomException - if the underlying native C function returns an error condition

setResourceCreate

public int setResourceCreate(boolean value)
                      throws FlomException

Set "resource create" boolean property: it specifies if method lock can create a new resource when the specified one is not defined. The current value can be inspected using method getResourceCreate.

Parameters:

value - (Input): the new value

Returns:

a reason code that can be checked to be sure the property was changed by the setter method

Throws:

FlomException - if the underlying native C function returns an error condition

getResourceIdleLifespan

public int getResourceIdleLifespan()
                            throws FlomException

Get "resource idle lifespan" property: it specifies how many milliseconds a resource will be kept after the last locker released it; the expiration is necessary to avoid useless resource allocation. The current value can be altered using method setResourceIdleLifespan.

Returns:

the current value

Throws:

FlomException - if the underlying native C function returns an error condition

setResourceIdleLifespan

public int setResourceIdleLifespan(int value)
                            throws FlomException

Set "resource idle lifespan" property: it specifies how many milliseconds a resource will be kept after the last locker released it; the expiration is necessary to avoid useless resource allocation. The current value can be inspected using method getResourceIdleLifespan.

Parameters:

value - (Input): the new value

Returns:

a reason code that can be checked to be sure the property was changed by the setter method

Throws:

FlomException - if the underlying native C function returns an error condition

getResourceName

public java.lang.String getResourceName()
                                 throws FlomException

Get the resource name: the name of the resource that can be locked and unlocked using lock and unlock methods. The current value can be altered using method setResourceName.

Returns:

the current value

Throws:

FlomException - if the underlying native C function returns an error condition

setResourceName

public int setResourceName(java.lang.String value)
                    throws FlomException

Set the resource name: the name of the resource that can be locked and unlocked using lock and unlock methods. The current value can be inspected using method getResourceName. NOTE: the resource type is determined by its name; take a look to flom command man page (-r, --resource-name option) for an explanation of the resource name grammar.

Parameters:

value - (Input): the new value

Returns:

a reason code that can be checked to be sure the property was changed by the setter method

Throws:

FlomException - if the underlying native C function returns an error condition

getResourceQuantity

public int getResourceQuantity()
                        throws FlomException

Get "resource quantity" property: the number of units that will be locked and unlocked using lock and unlock methods. The current value can be altered using method setResourceQuantity. NOTE: this property applies to "numeric resources" only.

Returns:

the current value

Throws:

FlomException - if the underlying native C function returns an error condition

setResourceQuantity

public int setResourceQuantity(int value)
                        throws FlomException

Set "resource quantity" property: the number of units that will be locked and unlocked using lock and unlock methods. The current value can be inspected using method getResourceQuantity. NOTE: this property applies to "numeric resources" only.

Parameters:

value - (Input): the new value

Returns:

a reason code that can be checked to be sure the property was changed by the setter method

Throws:

FlomException - if the underlying native C function returns an error condition

getResourceTimeout

public int getResourceTimeout()
                       throws FlomException

Get "resource timeout" property: how long a lock operation (see lock) will wait if the resource is locked by another requester. The current value can be altered using method setResourceTimeout.

Returns:

the current value:
0: no wait
> 0: maximum number of milliseconds to wait
< 0: unlimited wait

Throws:

FlomException - if the underlying native C function returns an error condition

setResourceTimeout

public int setResourceTimeout(int value)
                       throws FlomException

Set "resource timeout" property: how long a lock operation (see lock) will wait if the resource is locked by another requester. The current value can be inspected using method getResourceTimeout.

Parameters:

value - (Input): the new value:
0: no wait
> 0: maximum number of milliseconds to wait
< 0: unlimited wait

Returns:

a reason code that can be checked to be sure the property was changed by the setter method

Throws:

FlomException - if the underlying native C function returns an error condition

getSocketName

public java.lang.String getSocketName()
                               throws FlomException

Get the socket name: the AF_LOCAL/AF_UNIX socket name that must be used to contact a local FLoM daemon (server). The current value can be altered using method setSocketName.

Returns:

the current value as a standard

Throws:

FlomException - if the underlying native C function returns an error condition

setSocketName

public int setSocketName(java.lang.String value)
                  throws FlomException

Set the socket name: the AF_LOCAL/AF_UNIX socket name that must be used to contact a local FLoM daemon (server). The current value can be inspected using method getSocketName

Parameters:

value - (Input): the new value

Returns:

a reason code that can be checked to be sure the property was changed by the setter method

Throws:

FlomException - if the underlying native C function returns an error condition

getTraceFilename

public java.lang.String getTraceFilename()
                                  throws FlomException

Get the trace filename: the name (absolute or relative path) used by libflom (FLoM client library) to record trace messages. The current value can be altered using method setTraceFilename.

Returns:

the current value

Throws:

FlomException - if the underlying native C function returns an error condition

setTraceFilename

public int setTraceFilename(java.lang.String value)
                     throws FlomException

Set the trace filename: the name (absolute or relative path) used by libflom (FLoM client library) to record trace messages. The current value can be inspected using method getTraceFilename.

Parameters:

value - (Input): the new value

Returns:

a reason code that can be checked to be sure the property was changed by the setter method

Throws:

FlomException - if the underlying native C function returns an error condition

getUnicastAddress

public java.lang.String getUnicastAddress()
                                   throws FlomException

Get the unicast address: the IP address (or a network name that the system can resolve) of the host that must be contacted to reach FLoM daemon (server) using TCP/IP; see also getUnicastPort. The current value can be altered using method setUnicastAddress.

Returns:

the current value

Throws:

FlomException - if the underlying native C function returns an error condition

setUnicastAddress

public int setUnicastAddress(java.lang.String value)
                      throws FlomException

Set the unicast address: the IP address (or a network name that the system can resolve) of the host that must be contacted to reach FLoM daemon (server) using TCP/IP; see also setUnicastPort. The current value can be inspected using method getUnicastAddress.

Parameters:

value - (Input): the new value

Returns:

a reason code that can be checked to be sure the property was changed by the setter method

Throws:

FlomException - if the underlying native C function returns an error condition

getUnicastPort

public int getUnicastPort()
                   throws FlomException

Get the TCP/IP unicast port that must be used to contact the FLoM daemon (server) using TCP/IP; see also getUnicastAddress. The current value can be altered using method setUnicastPort.

Returns:

the current value

Throws:

FlomException - if the underlying native C function returns an error condition

setUnicastPort

public int setUnicastPort(int value)
                   throws FlomException

Set the TCP/IP unicast port that must be used to contact the FLoM daemon (server) using TCP/IP; see also setUnicastAddress. The current value can be inspected using method getUnicastPort.

Parameters:

value - (Input): the new value

Returns:

a reason code that can be checked to be sure the property was changed by the setter method

Throws:

FlomException - if the underlying native C function returns an error condition

getTlsCertificate

public java.lang.String getTlsCertificate()
                                   throws FlomException

Get the TLS certificate file name. The current value can be altered using method setTlsCertificate.

Returns:

the current value

Throws:

FlomException - if the underlying native C function returns an error condition

setTlsCertificate

public int setTlsCertificate(java.lang.String value)
                      throws FlomException

Set the TLS certificate file name. The current value can be inspected using method getTlsCertificate.

Parameters:

value - (Input): the new value

Returns:

a reason code that can be checked to be sure the property was changed by the setter method

Throws:

FlomException - if the underlying native C function returns an error condition

getTlsPrivateKey

public java.lang.String getTlsPrivateKey()
                                  throws FlomException

Get the TLS private key file name. The current value can be altered using method setTlsPrivateKey.

Returns:

the current value

Throws:

FlomException - if the underlying native C function returns an error condition

setTlsPrivateKey

public int setTlsPrivateKey(java.lang.String value)
                     throws FlomException

Set the TLS CA private key file name. The current value can be inspected using method getTlsPrivateKey.

Parameters:

value - (Input): the new value

Returns:

a reason code that can be checked to be sure the property was changed by the setter method

Throws:

FlomException - if the underlying native C function returns an error condition

getTlsCaCertificate

public java.lang.String getTlsCaCertificate()
                                     throws FlomException

Get the TLS CA certificate file name. The current value can be altered using method setTlsCaCertificate.

Returns:

the current value

Throws:

FlomException - if the underlying native C function returns an error condition

setTlsCaCertificate

public int setTlsCaCertificate(java.lang.String value)
                        throws FlomException

Set the TLS CA certificate file name. The current value can be inspected using method getTlsCaCertificate.

Parameters:

value - (Input): the new value

Returns:

a reason code that can be checked to be sure the property was changed by the setter method

Throws:

FlomException - if the underlying native C function returns an error condition

getTlsCheckPeerId

public boolean getTlsCheckPeerId()
                          throws FlomException

Get the TLS check peer ID flag value. The current value can be altered using method setTlsCheckPeerId.

Returns:

the current value

Throws:

FlomException - if the underlying native C function returns an error condition

setTlsCheckPeerId

public int setTlsCheckPeerId(boolean value)
                      throws FlomException

Set "TLS check peer ID" boolean property: it specifies if this node must check the unique ID presented by the remote peer. The current value can be inspected using method getTlsCheckPeerId.

Parameters:

value - (Input): the new value

Returns:

a reason code that can be checked to be sure the property was changed by the setter method

Throws:

FlomException - if the underlying native C function returns an error condition