18.2.5 ServerInfo interface

(a) Description

This method acquires the name of the EADS server (management directory name) that is executing the user function.

(b) Format

public String getName()

(c) Return value

This method returns the name of the EADS server (management directory name) that is executing the user function.

(a) Description

This method acquires the IP address and port number of the EADS server that is executing the user function.

(b) Format

public InetSocketAddress getAddress()

(c) Return value

This method returns a java.net.InetSocketAddress instance indicating the IP address and port number of a server.

(a) Description

This method acquires the EADS server ID of the EADS server that is executing the user function.

(b) Format

public int getId()

(c) Return value

This method returns the EADS server ID of the EADS server that is executing the user function.

(a) Description

This method acquires a list of cache names of the caches that have been created on the EADS server that is executing the user function.

The acquired cache names are listed in ascending order based on their ASCII code values.

(b) Format

public java.util.Set<String> getCacheNames()

(c) Return value

This method returns a list of cache names of the caches that have been created on the EADS server that is executing the user function.

If this method is called within init() or destroy() of the Function interface, null is returned.

(a) Description

This method acquires information about the cache type from the cache with a specified cache name.

(b) Format

public CacheType getCacheType(String cacheName)
                       throws EADsStoreException

(c) Parameters

cacheName

Specifies a cache name.

For details about the data that can be specified, see 15.2.2(4) Data types that can be specified as cache names.

If the name of a cache that has not been created is specified, an error results.

(d) Return value

This method returns information about the cache type.

If this method is called within init() or destroy() of the Function interface, null is returned.

(e) Exceptions

• UserOperationException (illegal user operation)

• EADsStoreException (unexpected error)

(a) Description

This method acquires the explicit heap size allocated for caches by the EADS server that is executing the user function.

(b) Format

public long getEHeapSize()
                  throws EADsStoreException

(c) Return value

This method returns the explicit heap size (in bytes) allocated for caches by the EADS server.

If this method is called within init() or destroy() of the Function interface, 0 is returned.

(d) Exceptions

• InternalServerException (EADS server internal error)

• EADsStoreException (unexpected error)

(a) Description

This method acquires the usage amount of the explicit heap allocated for caches by the EADS server that is executing the user function.

(b) Format

public long getEHeapSize()
                  throws EADsStoreException

(c) Return value

This method returns the usage amount (in bytes) of the explicit heap allocated for caches by the EADS server.

If this method is called within init() or destroy() of the Function interface, 0 is returned.

(d) Exceptions

• InternalServerException (EADS server internal error)

• EADsStoreException (unexpected error)

(a) Description

This method acquires the size (in bytes) of one cache data file (value defined in the cache property file).

(b) Format

public long getCacheDataFileSpecifiedSize(String cacheName)
                                   throws EADsStoreException

(c) Parameters

cacheName

Specifies a cache name.

For details about the data that can be specified, see 15.2.2(4) Data types that can be specified as cache names.

If the name of a cache that has not been created is specified, an error results.

(d) Return value

This method returns the size (in bytes) of one cache data file (value defined in the cache property file).

If this method is called within init() or destroy() of the Function interface, null is returned.

(e) Exceptions

• UserOperationException (illegal user operation)

• EADsStoreException (unexpected error)

(a) Description

This method acquires the size (in bytes) of the space available for storing persistent data in the cache data file currently under import processing.

(b) Format

public long getCacheDataFileRemainingSize(String cacheName, String key)
                                   throws EADsStoreException

(c) Parameters

cacheName

Specifies a cache name.

For details about the data that can be specified, see 15.2.2(4) Data types that can be specified as cache names.

If the name of a cache that has not been created is specified, an error results.

key

Specifies a key to be associated with the value. The specification must be a group name.

For details about the data that can be specified, see 15.2.2(1) Data types that can be specified as keys.

Note that if the specified key does not belong to the EADS server that is executing the user function, an error results.

(d) Return value

This method returns the size (in bytes) of the space available for storing persistent data in the cache data file currently under import processing.

If this method is called within init() or destroy() of the Function interface, 0 is returned.

(e) Exceptions

• UserOperationException (illegal user operation)

• InternalServerException (EADS server internal error)

• EADsStoreException (unexpected error)

(f) Notes

• The available file size returned by this method is the information at the time the method executes. This value might change due to cache operations or compaction.

• This method acquires information about the EADS server that is executing this method. The method cannot acquire information about other EADS servers.

• If this method's return value indicates sufficient space in the cache data files but a space shortage has occurred on the EADS server to which data is to be copied, that target EADS server will be isolated when data is actually stored. Determine whether data can actually be stored taking into account the available space on the target EADS server in addition to this method's return value.

(a) Description

This method acquires the number of cache data files (value defined in the cache property file).

(b) Format

public int getCacheDataFileSpecifiedNumber(String cacheName)
                                    throws EADsStoreException

(c) Parameters

cacheName

Specifies a cache name.

For details about the data that can be specified, see 15.2.2(4) Data types that can be specified as cache names.

If the name of a cache that has not been created is specified, an error results.

(d) Return value

This method returns the number of cache data files (value defined in the cache property file).

If this method is called within init() or destroy() of the Function interface, 0 is returned.

(e) Exceptions

• UserOperationException (illegal user operation)

• EADsStoreException (unexpected error)

(a) Description

This method acquires the number of unused cache data files that are currently available.

(b) Format

public int getCacheDataFileUnusedNumber(String cacheName, String key)
                                 throws EADsStoreException

(c) Parameters

cacheName

Specifies a cache name.

For details about the data that can be specified, see 15.2.2(4) Data types that can be specified as cache names.

If the name of a cache that has not been created is specified, an error results.

key

Specifies a key to be associated with the value. The specification must be a group name.

For details about the data that can be specified, see 15.2.2(1) Data types that can be specified as keys.

Note that if the specified key does not belong to the EADS server that is executing the user function, an error results.

(d) Return value

This method returns the number of unused cache data files that are currently available. This value does not include the number of files reserved by the EADS server.

If the cache data file currently under import processing is the last available cache data file, the method returns 0.

If this method is called within init() or destroy() of the Function interface, 0 is returned.

(e) Exceptions

• UserOperationException (illegal user operation)

• InternalServerException (EADS server internal error)

• EADsStoreException (unexpected error)

(f) Notes

• The number of unused files returned by this method is the information at the time the method executes. This value might change due to cache operations or compaction.

• This method acquires information about the EADS server that is executing this method. The method cannot acquire information about other EADS servers.

• If this method's return value indicates sufficient space in the cache data files but a space shortage has occurred on the EADS server to which data is to be copied, that target EADS server will be isolated when data is actually stored. Determine whether data can actually be stored taking into account the available space on the target EADS server in addition to this method's return value.