Package com.ellucian.ethos.integration

Class EthosIntegrationUrls

java.lang.Object

com.ellucian.ethos.integration.EthosIntegrationUrls

public class EthosIntegrationUrls
extends Object

Utility class used for building Ethos Integration URLs with various criteria.

Constructor Summary

Constructors

Constructor	Description
EthosIntegrationUrls()

Method Summary

Modifier and Type	Method	Description
static String	apiFilter(SupportedRegions region, String resource, String filter)	Builds a URL for interacting with the proxy APIs through Ethos Integration supporting filters.
static String	apiFilterPaging(SupportedRegions region, String resource, String filter, int offset, int pageSize)	Builds a URL for interacting with the proxy APIs through Ethos Integration supporting paging with filters.
static String	apiPaging(SupportedRegions region, String resource, int offset, int pageSize)	Builds a URL for interacting with the Proxy APIs through Ethos Integration, in support of paging.
static String	apis(SupportedRegions region, String resource, String id)	Builds a URL for interacting with the Proxy APIs through Ethos Integration.
static String	appConfig(SupportedRegions region)	Builds an Ethos Integration URL supporting the Application Configuration API.
static String	auth(SupportedRegions region)	Builds an Ethos Integration URL supporting the Token API.
static String	availableResources(SupportedRegions region)	Builds an Ethos Integration URL supporting the Available Resources API.
static String	consume(SupportedRegions region, long lastProcessedID, int limit)	Builds an Ethos Integration URL supporting the consume API.
static String	errors(SupportedRegions region)	Builds an Ethos Integration URL supporting the Errors API.
static String	errorsPaging(SupportedRegions region, int offset, int pageSize)	Builds a URL for interacting with the Errors API through Ethos Integration, in support of paging.
static String	qapiPaging(SupportedRegions region, String resource, int offset, int pageSize)	Builds a URL for interacting with the proxy APIs through Ethos Integration supporting paging for QAPI POST requests
static String	qapis(SupportedRegions region, String resource)	Builds a URL for interacting with the Proxy APIs through Ethos Integration for QAPI POST requests.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EthosIntegrationUrls

public EthosIntegrationUrls()

Method Detail

apis

public static String apis(SupportedRegions region,
                          String resource,
                          String id)

Builds a URL for interacting with the Proxy APIs through Ethos Integration.

Parameters:

region - The appropriate supported region to build the URL with.

resource - The Ethos resource the URL should contain.

id - The (optional) ID for the given resource to build URLs for "get by ID" requests.

Returns:

A String value containing the URL to use for interacting with Ethos Integration Proxy APIs.

apiFilter

public static String apiFilter(SupportedRegions region,
                               String resource,
                               String filter)

Builds a URL for interacting with the proxy APIs through Ethos Integration supporting filters.

Parameters:

region - The appropriate supported region to build the URL with.

resource - The Ethos resource the URL should contain.

filter - The resource filter the URL should contain.

Returns:

A String value containing the URL to use for interacting with Ethos Integration Proxy APIs, supporting filters.

apiFilterPaging

public static String apiFilterPaging(SupportedRegions region,
                                     String resource,
                                     String filter,
                                     int offset,
                                     int pageSize)

Builds a URL for interacting with the proxy APIs through Ethos Integration supporting paging with filters.

Parameters:

region - The appropriate supported region to build the URL with.

resource - The Ethos resource the URL should contain.

filter - The resource filter the URL should contain.

offset - The row index from which to begin paging for data for the given resource.

pageSize - The number of rows each response can contain.

Returns:

A String value containing the URL to use for interacting with Ethos Integration Proxy APIs, supporting filters.

apiPaging

public static String apiPaging(SupportedRegions region,
                               String resource,
                               int offset,
                               int pageSize)

Builds a URL for interacting with the Proxy APIs through Ethos Integration, in support of paging.

Parameters:

region - The appropriate supported region to build the URL with.

resource - The Ethos resource the URL should contain.

offset - The row index from which to begin paging for data for the given resource.

pageSize - The number of rows each response can contain.

Returns:

A String value containing the URL to use for interacting with Ethos Integration Proxy APIs, in support of paging.

errorsPaging

public static String errorsPaging(SupportedRegions region,
                                  int offset,
                                  int pageSize)

Builds a URL for interacting with the Errors API through Ethos Integration, in support of paging.

Parameters:

region - The appropriate supported region to build the URL with.

offset - The row index from which to begin paging for errors.

pageSize - The number of errors (limit) each response can contain.

Returns:

A String value containing the URL to use for interacting with Ethos Integration Errors API, in support of paging.

errors

public static String errors(SupportedRegions region)

Builds an Ethos Integration URL supporting the Errors API.

Parameters:

region - The appropriate supported region to build the URL with.

Returns:

A String value containing the URL to use for interacting with Ethos Integration Errors APIs.

qapis

public static String qapis(SupportedRegions region,
                           String resource)

Builds a URL for interacting with the Proxy APIs through Ethos Integration for QAPI POST requests.

Parameters:

region - The appropriate supported region to build the URL with.

resource - The Ethos resource the URL should contain.

Returns:

A String value containing the URL to use for interacting with Ethos Integration Proxy APIs.

qapiPaging

public static String qapiPaging(SupportedRegions region,
                                String resource,
                                int offset,
                                int pageSize)

Builds a URL for interacting with the proxy APIs through Ethos Integration supporting paging for QAPI POST requests

Parameters:

region - The appropriate supported region to build the URL with.

resource - The Ethos resource the URL should contain.

offset - The row index from which to begin paging for data for the given resource.

pageSize - The number of rows each response can contain.

Returns:

A String value containing the URL to use for interacting with Ethos Integration Proxy APIs.

auth

public static String auth(SupportedRegions region)

Builds an Ethos Integration URL supporting the Token API.

Parameters:

region - The appropriate supported region to build the URL with.

Returns:

A String value containing the URL to use for interacting with Ethos Integration Token API.

appConfig

public static String appConfig(SupportedRegions region)

Builds an Ethos Integration URL supporting the Application Configuration API.

Parameters:

region - The appropriate supported region to build the URL with.

Returns:

A String value containing the URL to use for interacting with Ethos Integration Application Configuration API.

availableResources

public static String availableResources(SupportedRegions region)

Builds an Ethos Integration URL supporting the Available Resources API.

Parameters:

region - The appropriate supported region to build the URL with.

Returns:

A String value containing the URL to use for interacting with Ethos Integration Available Resources API.

consume

public static String consume(SupportedRegions region,
                             long lastProcessedID,
                             int limit)

Builds an Ethos Integration URL supporting the consume API.

Parameters:

region - The appropriate supported region to build the URL with.

lastProcessedID - A value to use for the 'lastProcessedID' query parameter. Any value of zero or greater will be added to the URL as a query parameter. If the value is less than zero, it will not be added to the URL.

limit - A value to use for the 'limit' query parameter. Any value greater than zero will be added to the URL as a query parameter. If the value is zero or less, it will not be added to the URL.

Returns:

The URL to use for calling the Ethos Integration consume endpoint.