Skip navigation links

com.bharosa.vcrypt.common.intf
Interface VCryptCommon

public interface VCryptCommon

This provides the common interfaces which are used by all VCrypt products. List methods do not work for Alert lists.

Field Summary

static String	REQ_CREATE_LIST
static String	REQ_IS_ELEMENT_IN_LIST
static String	REQ_LIST_BY_TYPE
static String	REQ_LIST_ELEMENTS
static String	REQ_UPDATE_LIST

Method Summary

VCryptResponse	createList(String requestId, String listName, int listType) Creates a new List of the give list type
VCryptStringArrayResponse	getListElements(String requestId, String listName) Get list of members of a group Alert group list is not supported.
VCryptStringArrayResponse	getLists(String requestId, int listType) Get a list of groups given a group type
VCryptBooleanResponse	isElementInList(String requestId, String listName, String elementValue) This checks whether the element given is in the list.
VCryptResponse	updateList(String requestId, String listName, String[] elementsToAdd, String[] elementsToRemove) Updates given list with new elements.

Field Detail

REQ_LIST_ELEMENTS

static final String REQ_LIST_ELEMENTS

See Also:

Constant Field Values

REQ_LIST_BY_TYPE

static final String REQ_LIST_BY_TYPE

See Also:

Constant Field Values

REQ_UPDATE_LIST

static final String REQ_UPDATE_LIST

See Also:

Constant Field Values

REQ_IS_ELEMENT_IN_LIST

static final String REQ_IS_ELEMENT_IN_LIST

See Also:

Constant Field Values

REQ_CREATE_LIST

static final String REQ_CREATE_LIST

See Also:

Constant Field Values

Method Detail

getListElements

VCryptStringArrayResponse getListElements(String requestId,
                                          String listName)

Get list of members of a group Alert group list is not supported.

Parameters:

requestId - Request Identifier

listName - Name of the list

Returns:

VCryptGetListsResponse

getLists

VCryptStringArrayResponse getLists(String requestId,
                                   int listType)

Get a list of groups given a group type

Parameters:

requestId - Request Identifier

listType - list type

Returns:

VCryptGetListsResponse

updateList

VCryptResponse updateList(String requestId,
                          String listName,
                          String[] elementsToAdd,
                          String[] elementsToRemove)

Updates given list with new elements. List name should be an existing. Duplicate and invalid elements in elementsToAdd are ignored. Non-existing and invalid elements in elementsToRemove are ignored. Update of alert group list is not supported.

Parameters:

requestId - Request Identifier

listName - Name of the list, an existing list.

elementsToAdd - elements to be added to list

elementsToRemove - elements to remove from the list

Returns:

VCryptResponse

isElementInList

VCryptBooleanResponse isElementInList(String requestId,
                                      String listName,
                                      String elementValue)

This checks whether the element given is in the list. Checks of elements in alert group list are not supported.

Parameters:

requestId - Request Identifier

listName - Name of the list

elementValue - Value of the element to look for. This will be converted to appropriate native type before search.

Returns:

Response object with the response value and response status

createList

VCryptResponse createList(String requestId,
                          String listName,
                          int listType)

Creates a new List of the give list type

Parameters:

requestId - Request Id

listName - Name of the list

listType - Type of the list

Returns:

VCryptResponse with the result

Skip navigation links