Helper Methods

The Context Service SDK provides helper methods that make your code more concise, via two classes:

SDKUtils
DataElementUtils

SDKUtils

Use SDKUtils to get IDs, lastUpdated, and locations from responses:

getIdFromResponse(Response)—Uses the response returned from creating a type of ContextObject to return an ID as a string. Depending on the type of ContextObject, the ID can be a customerID, podID, or a parentId.
getLastUpdatedFromResponse(Response)—Uses the response returned from creating a type of ContextObject to get a RFC3339Date.
getIdFromUrl(url)—Returns an ID, as a string, when you provide a location. For example, from response.getLocation().toString().

java

Copy/**
 * Get Pod ID from the ClientResponse returned from ContextServiceClient.create()
 * Pod.getId() is preferred!
 * @param contextServiceClient an initialized context service client
 * @param pod a Pod object that hasn't been created in Context Service yet
 * @return the id of the newly created Pod
 */
public static String getIdFromCreatePodResponse(ContextServiceClient contextServiceClient, ContextObject pod) {
    ClientResponse response = contextServiceClient.create(pod);
    return SDKUtils.getIdFromResponse(response);
}

/**
 * Get the lastUpdated timestamp from the ClientResponse returned from ContextServiceClient.create()
 * Pod.getLastUpdated() is preferred!
 * @param contextServiceClient an initialized context service client
 * @param pod a Pod object that hasn't been created in Context Service yet
 * @return the lastUpdated time of the new Pod
 */
public static RFC3339Date getLastUpdatedFromCreatePodResponse(ContextServiceClient contextServiceClient, ContextObject pod) {
    ClientResponse response = contextServiceClient.create(pod);
    return SDKUtils.getLastUpdatedFromResponse(response);
}

DataElementUtils

Use DataElementUtils to work with Java Sets in DataElements. It is easier to create or modify a Java Map than it is to create or modify a Java Set. The convertMapToDataSet() and convertDataSetToMap() helper methods allow you handle DataElements as Java Maps, while still allowing the interfaces to use them as Java Sets.

getDataElements() returns a Set. convertDataSetToMap(Set<DataElement> dataElements) takes the set of data elements returned by the .getDataElements method and returns a map.

setDataElements() requires a Set. It is easier to define a Map of key/value pairs to load into an Activity, Customer, or Request, than it is to define a Set with the same information.

java

Copy// examples demonstrating dataElements usage
/**
 * Create a Customer with default fields and fieldsets.
 * @param contextServiceClient an initialized ContextServiceClient
 * @return a newly-created customer with the cisco.base.customer fieldset
 */
public static ContextObject createCustomerWithBaseFieldset(ContextServiceClient contextServiceClient) {
    ContextObject customer = new ContextObject(ContextObject.Types.CUSTOMER);
    customer.setDataElements(
            DataElementUtils.convertDataMapToSet(
                    new HashMap<String, Object>() {{
                        put("Context_Work_Email", "john.doe@example.com");
                        put("Context_Work_Phone", "555-555-5555");
                        put("Context_First_Name", "John");
                        put("Context_Last_Name", "Doe");
                        put("Context_Street_Address_1", "123 Sesame Street");
                        put("Context_City", "Detroit");
                        put("Context_State", "MI");
                        put("Context_Country", "US");
                        put("Context_ZIP", "90210");
                    }}
            )
    );
    customer.setFieldsets(Arrays.asList("cisco.base.customer"));
    contextServiceClient.create(customer);
    return customer;
}

/**
 * Update a Customer.
 * @param contextServiceClient an initialized ContextServiceClient
 * @param customerId
 * @return the updated Customer
 */
public static ContextObject updateCustomer(ContextServiceClient contextServiceClient, UUID customerId) {
    ContextObject customer = contextServiceClient.getContextObject(ContextObject.Types.CUSTOMER, customerId.toString());
    Map<String, Object> updateData = DataElementUtils.convertDataSetToMap(customer.getDataElements());
    updateData.put("Context_Street_Address_1", "333 Sesame Street");
    customer.setDataElements(DataElementUtils.convertDataMapToSet(updateData));
    contextServiceClient.update(customer);
    return customer;
}