com.cisco.thunderhead.client

Interface ContextServiceClient

All Superinterfaces:

Connector, Plugin

public interface ContextServiceClient
extends Connector, Plugin

Context-service client interface.

Method Summary

Modifier and Type	Method and Description
<T extends BaseDbBean> ClientResponse	create(T bean) Inspects the object, handles encryption and creating through the proper API.
<T extends BaseDbBean> ClientResponse	create(T bean, UserAuthInfo userAuthInfo) Inspects the object, handles encryption and creating through the proper API.
<T extends BaseDbBean> void	delete(Class<T> classType, String locationUrl) Deletes the object.
<T extends BaseDbBean> void	delete(Class<T> classType, String locationUrl, UserAuthInfo userAuthInfo) Deletes the object.
<T extends BaseDbBean> void	delete(T bean) Deletes the object.
<T extends BaseDbBean> void	delete(T bean, UserAuthInfo userAuthInfo) Deletes the object.
void	deleteContextObject(String type, String locationUrl) Deletes a context object.
void	deleteContextObject(String type, String locationUrl, UserAuthInfo userAuthInfo) Deletes a context object.
<T extends BaseDbBean> void	flush(Class<T> classType) Flushes (deletes) all the objects in your organization that are part of your workgroup.
<T extends BaseDbBean> void	flush(Class<T> classType, UserAuthInfo userAuthInfo) Flushes (deletes) all the objects in your organization that are part of your workgroup.
void	flush(String type) Flushes (deletes) all the objects in your organization that are part of your workgroup.
void	flush(String type, UserAuthInfo userAuthInfo) Flushes (deletes) all the objects in your organization that are part of your workgroup.
<T extends BaseDbBean> T	get(Class<T> classType, String locationUrl) Retrieves the object through the proper API and decrypts it before returning to the user.
<T extends BaseDbBean> T	get(Class<T> classType, String locationUrl, UserAuthInfo userAuthInfo) Retrieves the object through the proper API and decrypts it before returning to the user.
AccessToken	getAccessToken(String scope) Gets access token.
ContextObject	getContextObject(String type, String locationUrl) Retrieves a context object through the proper API and decrypts it before returning to the user.
ContextObject	getContextObject(String type, String locationUrl, UserAuthInfo userAuthInfo) Retrieves a context object through the proper API and decrypts it before returning to the user.
<T extends BaseDbBean> List<T>	search(Class<T> classType, SearchParameters searchParams, Operation op) Searches for all objects matching the search params for the API.
<T extends BaseDbBean> List<T>	search(Class<T> classType, SearchParameters searchParams, Operation op, UserAuthInfo userAuthInfo) Searches for all objects matching the search params for the API.
<T extends BaseDbBean> ClientResponse	update(T bean) Inspects the object, handles encryption and updating through the proper API.
<T extends BaseDbBean> ClientResponse	update(T bean, UserAuthInfo userAuthInfo) Inspects the object, handles encryption and updating through the proper API.
<T extends BaseDbBean> FlushStatusBean	waitForFlushComplete(Class<T> classType, int waitSeconds) Wait for flush to complete.
<T extends BaseDbBean> FlushStatusBean	waitForFlushComplete(Class<T> classType, int waitSeconds, UserAuthInfo userAuthInfo) Wait for flush to complete.
FlushStatusBean	waitForFlushComplete(String type, int waitSeconds) Wait for flush to complete.
FlushStatusBean	waitForFlushComplete(String type, int waitSeconds, UserAuthInfo userAuthInfo) Wait for flush to complete.

Methods inherited from interface com.cisco.thunderhead.connector.Connector

addStateListener, destroy, getStatus, getVersion, handleException, init, init, removeStateListener, updateAndReloadConfigAsync, updateAndReloadConfigSync

Method Detail

create

<T extends BaseDbBean> ClientResponse create(T bean)

Inspects the object, handles encryption and creating through the proper API. Supported for ContextObject, Pod, Request, and Customer.

Type Parameters:

T - Type of bean

Parameters:

bean - bean to create

Returns:

ClientResponse that contains location Url to the updated bean

create

<T extends BaseDbBean> ClientResponse create(T bean,
                                             UserAuthInfo userAuthInfo)

Inspects the object, handles encryption and creating through the proper API. Supported for ContextObject, Pod, Request, and Customer.

Type Parameters:

T - Type of bean

Parameters:

bean - bean to create

userAuthInfo - the access token and user information to do this operation

Returns:

ClientResponse that contains location Url to the updated bean

update

<T extends BaseDbBean> ClientResponse update(T bean)

Inspects the object, handles encryption and updating through the proper API. Supported for ContextObject, Pod, Request, and Customer.

Type Parameters:

T - Type of bean

Parameters:

bean - bean to update

Returns:

ClientResponse that contains location Url to the updated bean

update

<T extends BaseDbBean> ClientResponse update(T bean,
                                             UserAuthInfo userAuthInfo)

Inspects the object, handles encryption and updating through the proper API. Supported for ContextObject, Pod, Request, and Customer.

Type Parameters:

T - Type of bean

Parameters:

bean - bean to update

userAuthInfo - the access token and user information to do this operation

Returns:

ClientResponse that contains location Url to the updated bean

get

<T extends BaseDbBean> T get(Class<T> classType,
                             String locationUrl)

Retrieves the object through the proper API and decrypts it before returning to the user. Supported for ContextObject, Pod, Request, and Customer.

Type Parameters:

T - Type of bean

Parameters:

classType - type of bean

locationUrl - location URL of the object to obtain. Can be either absolute, relative, or (if the type isn't ContextObject) just the ID.

Returns:

decrypted bean

get

<T extends BaseDbBean> T get(Class<T> classType,
                             String locationUrl,
                             UserAuthInfo userAuthInfo)

Retrieves the object through the proper API and decrypts it before returning to the user. Supported for ContextObject, Pod, Request, and Customer.

Type Parameters:

T - Type of bean

Parameters:

classType - type of bean

locationUrl - location URL of the object to obtain. Can be either absolute, relative, or (if the type isn't ContextObject) just the ID.

userAuthInfo - the access token and user information to do this operation

Returns:

decrypted bean

getContextObject

ContextObject getContextObject(String type,
                               String locationUrl)

Retrieves a context object through the proper API and decrypts it before returning to the user.

Parameters:

type - The type of context object to get.

locationUrl - location URL of the object to obtain. Can be either absolute, relative, or just the ID.

Returns:

decrypted bean

getContextObject

ContextObject getContextObject(String type,
                               String locationUrl,
                               UserAuthInfo userAuthInfo)

Retrieves a context object through the proper API and decrypts it before returning to the user.

Parameters:

type - The type of context object to get.

locationUrl - location URL of the object to obtain. Can be either absolute, relative, or just the ID.

userAuthInfo - the access token and user information to do this operation

Returns:

decrypted bean

search

<T extends BaseDbBean> List<T> search(Class<T> classType,
                                      SearchParameters searchParams,
                                      Operation op)

Searches for all objects matching the search params for the API. Currently supports a single operand (AND or OR) between all terms.

Supported for:
- POD:
- customerId (i.e. customerId:7288db10-5886-4f3a-a816-c5860a82b229), multiple elements not allowed
- startDate (i.e. 2015-03-11T19:01:16.919Z), optional lastUpdated/created date
- endDate (i.e. 2015-03-11T19:01:16.919Z), optional lastUpdated date
- startCreatedDate (i.e. 2015-03-11T19:01:16.919Z), optional created date
- endCreatedDate (i.e. 2015-03-11T19:01:16.919Z), optional lastUpdated/created date
- maxEntries optional, defaults to 50
- Request: any meta data pairs (i.e. age:30, level:gold)
- Customer: pii elements (email:name@domain.com, phone:555-555-5555), returns all customers matching the elements
- Field: names (id:name, id:email), returns all fields in the map - FieldSet: names (id:cisco.base.pod), returns all fieldsets in the map

Type Parameters:

T - type of bean

Parameters:

classType - type of bean

searchParams - key-value search parameters

op - operation to use if multiple search params present

Returns:

decrypted objects matching the search params.

search

<T extends BaseDbBean> List<T> search(Class<T> classType,
                                      SearchParameters searchParams,
                                      Operation op,
                                      UserAuthInfo userAuthInfo)

Searches for all objects matching the search params for the API. Currently supports a single operand (AND or OR) between all terms.

Supported for:
- POD:
- customerId (i.e. customerId:7288db10-5886-4f3a-a816-c5860a82b229), multiple elements not allowed
- startDate (i.e. 2015-03-11T19:01:16.919Z), optional lastUpdated/created date
- endDate (i.e. 2015-03-11T19:01:16.919Z), optional lastUpdated date
- startCreatedDate (i.e. 2015-03-11T19:01:16.919Z), optional created date
- endCreatedDate (i.e. 2015-03-11T19:01:16.919Z), optional lastUpdated/created date
- maxEntries optional, defaults to 50
- Request: any meta data pairs (i.e. age:30, level:gold)
- Customer: pii elements (email:name@domain.com, phone:555-555-5555), returns all customers matching the elements

Type Parameters:

T - type of bean

Parameters:

classType - type of bean

searchParams - key-value search parameters

op - operation to use if multiple search params present

userAuthInfo - the access token and user information to do this operation

Returns:

decrypted objects matching the search params.

delete

<T extends BaseDbBean> void delete(T bean)

Deletes the object. (Only works in lab mode)

Type Parameters:

T - type of bean

Parameters:

bean - object to delete

delete

<T extends BaseDbBean> void delete(T bean,
                                   UserAuthInfo userAuthInfo)

Deletes the object. (Only works in lab mode)

Type Parameters:

T - type of bean

Parameters:

bean - object to delete

userAuthInfo - the access token and user information to do this operation

delete

<T extends BaseDbBean> void delete(Class<T> classType,
                                   String locationUrl)

Deletes the object. (Only works in lab mode)

Type Parameters:

T - type of bean

Parameters:

locationUrl - location of the object to delete. Can be either absolute, relative, or (if the type isn't ContextObject) just the ID.

classType - type of bean

delete

<T extends BaseDbBean> void delete(Class<T> classType,
                                   String locationUrl,
                                   UserAuthInfo userAuthInfo)

Deletes the object. (Only works in lab mode)

Type Parameters:

T - type of bean

Parameters:

locationUrl - location of the object to delete. Can be either absolute, relative, or (if the type isn't ContextObject) just the ID.

classType - type of bean

userAuthInfo - the access token and user information to do this operation

deleteContextObject

void deleteContextObject(String type,
                         String locationUrl)

Deletes a context object. (Only works in lab mode)

Parameters:

type - The type of context object to delete.

locationUrl - location of the object to delete. Can be either absolute, relative, or just the ID.

deleteContextObject

void deleteContextObject(String type,
                         String locationUrl,
                         UserAuthInfo userAuthInfo)

Deletes a context object. (Only works in lab mode)

Parameters:

type - The type of context object to delete.

locationUrl - location of the object to delete. Can be either absolute, relative, or just the ID.

userAuthInfo - the access token and user information to do this operation

flush

<T extends BaseDbBean> void flush(Class<T> classType)

Flushes (deletes) all the objects in your organization that are part of your workgroup. (Only works in lab mode)

Type Parameters:

T - type of bean

Parameters:

classType - type of bean

flush

void flush(String type)

Flushes (deletes) all the objects in your organization that are part of your workgroup. (Only works in lab mode)

Parameters:

type - The type of context object to flush.

flush

<T extends BaseDbBean> void flush(Class<T> classType,
                                  UserAuthInfo userAuthInfo)

Flushes (deletes) all the objects in your organization that are part of your workgroup. (Only works in lab mode)

Type Parameters:

T - type of bean

Parameters:

classType - type of bean

userAuthInfo - the access token and user information to do this operation

flush

void flush(String type,
           UserAuthInfo userAuthInfo)

Flushes (deletes) all the objects in your organization that are part of your workgroup. (Only works in lab mode)

Parameters:

type - The type of context object to flush.

userAuthInfo - the access token and user information to do this operation

waitForFlushComplete

<T extends BaseDbBean> FlushStatusBean waitForFlushComplete(Class<T> classType,
                                                            int waitSeconds)

Wait for flush to complete.

Parameters:

classType - type of bean

waitSeconds - maximum time, in seconds, to wait for flush to complete

Returns:

FlushStatusBean for completion (if completed) or at last check (if timed out)

waitForFlushComplete

FlushStatusBean waitForFlushComplete(String type,
                                     int waitSeconds)

Wait for flush to complete.

Parameters:

type - The type of context object being flushed.

waitSeconds - maximum time, in seconds, to wait for flush to complete

Returns:

FlushStatusBean for completion (if completed) or at last check (if timed out)

waitForFlushComplete

<T extends BaseDbBean> FlushStatusBean waitForFlushComplete(Class<T> classType,
                                                            int waitSeconds,
                                                            UserAuthInfo userAuthInfo)

Wait for flush to complete.

Parameters:

classType - type of bean

waitSeconds - maximum time, in seconds, to wait for flush to complete

Returns:

FlushStatusBean for completion (if completed) or at last check (if timed out)

waitForFlushComplete

FlushStatusBean waitForFlushComplete(String type,
                                     int waitSeconds,
                                     UserAuthInfo userAuthInfo)

Wait for flush to complete.

Parameters:

type - The type of context object being flushed.

waitSeconds - maximum time, in seconds, to wait for flush to complete

Returns:

FlushStatusBean for completion (if completed) or at last check (if timed out)

getAccessToken

AccessToken getAccessToken(String scope)

Gets access token.

Parameters:

scope - the scope

Returns:

the access token