Hitachi

In-Memory Data Grid Hitachi Elastic Application Data Store


18.2 API interfaces supported in user functions

The following table lists and describes the API interfaces supported in user functions.

Table 18‒2: API interfaces supported in user functions

No.

Interface name, class name, or enumeration

Description

Package name

1

Function

This interface must be implemented in the user functions used on the EADS servers.

com.hitachi.software.xeads.func.Function

2

FunctionContext

This interface passes to the Function interface information needed to execute a user function.

com.hitachi.software.xeads.func.FunctionContext

3

InitConfig

This interface acquires information about the function properties used to initialize a user function.

com.hitachi.software.xeads.func.InitConfig

4

ClientInfo

This interface acquires information about the EADS client that executed the API method.

com.hitachi.software.xeads.common.ClientInfo

5

ServerInfo

This interface acquires information about an EADS server.

com.hitachi.software.xeads.common.ServerInfo

6

ClusterInfo

This interface acquires information about the cluster.

com.hitachi.software.xeads.common.ClusterInfo

7

CacheInfo

This interface acquires information about caches.

com.hitachi.software.xeads.common.CacheInfo

8

Store

This interface manipulates data during execution of a user function.

com.hitachi.software.xeads.func.store.Store

9

Group

This interface manipulates the group belonging to the EADS server that is executing a user function.

com.hitachi.software.xeads.func.store.Group

10

Key

This interface represents keys in the API methods that can be used in user functions.

com.hitachi.software.xeads.func.store.Key

11

Value

This interface represents values that are associated with keys and stored in the API methods that can be used in user functions.

com.hitachi.software.xeads.func.store.Value

12

UserLogger

This interface is for user logs.

com.hitachi.software.xeads.common.UserLogger

13

EADsStoreException

This exception class is returned when processing related to a data operation fails.

com.hitachi.software.xeads.func.store.EADsStoreException

14

InternalServerException

This is a subclass of EADsStoreException that is returned when an internal error occurs on the EADS server.

com.hitachi.software.xeads.func.store.InternalServerException

15

UserOperationException

This is a subclass of EADsStoreException that is returned when an error occurs due to an illegal user operation.

com.hitachi.software.xeads.func.store.UserOperationException

16

Enumeration CacheType

This enumeration represents the cache types.

com.hitachi.software.xeads.common.CacheType

Organization of this section