org.axway.grapes.commons.api
Interface ServerAPI

public interface ServerAPI

Grapes Server Resources Interface

This interface gathers the resources available on a Grapes server.

Warning: Make sure that the version of grapes-commons you use is compatible with the targeted Grapes server

Author:

jdcoffre

Field Summary

static String	APPROVED_PARAM Value - "approved", boolean query parameter used for licenses.
static String	ARTIFACT_RESOURCE Value - "artifact", Artifact is a Grapes server resource that handles the information about artifacts.
static String	ARTIFACTID_PARAM Value - "artifactId", String query parameter used to filter artifacts.
static String	CLASSIFIER_PARAM Value - "classifier", String query parameter used to filter artifacts.
static String	DEPTH_PARAM Value - "depth", integer query parameter that is used to set a depth into the dependency result.
static String	DO_NOT_USE Value - "doNotUse", String query parameter used to filter/update the field "DO_NOT_USE" of an artifact.
static String	EXTENSION_PARAM Value - "extension", String query parameter used to filter artifacts.
static String	GAVC Value - "gavc", String query parameter used to filter artifacts.
static String	GET_ALL Value - "/all", GET methods that retrieve all the elements of a resource type.
static String	GET_ANCESTORS Value - "/ancestors", GET methods that returns the ancestor of the targeted resource.
static String	GET_BUILD_INFO Value - "/buildInfo", GET methods that returns TRUE if the targeted module is promoted.
static String	GET_CORPORATE_GROUPIDS Value - "/corporateGroupIds", GET methods that returns the list of corporate groupIds.
static String	GET_DELIVERIES Value - "/deliveries", GET methods that returns the deliveries of a product.
static String	GET_DEPENDENCIES Value - "/dependencies", GET methods that returns the dependencies of the targeted resource.
static String	GET_DOWNLOAD_URL Value - "/downloadurl", GET methods that returns the versions of the targeted resource.
static String	GET_FEASIBLE Value - "/doable", POST methods used to know if the promotion can be done.
static String	GET_GAVCS Value - "/gavcs", GET methods that returns the gavcs of the targeted artifacts.
static String	GET_GROUPIDS Value - "/groupIds", GET methods that returns the groupids of the targeted artifacts.
static String	GET_LAST_VERSION Value - "/lastversion", GET methods that returns the last version of the targeted resource.
static String	GET_LICENSES Value - "/licenses", GET methods that returns the licenses of the targeted resource.
static String	GET_MODULE Value - "/module", GET methods that returns the module of an artifact.
static String	GET_MODULES Value - "/modules", GET methods that returns the modules of a product.
static String	GET_NAMES Value - "/names", GET methods that returns the names of the targeted resources.
static String	GET_ORGANIZATION Value - "/organization", GET methods that returns the organization of an Artifact or a Module.
static String	GET_PROVIDER Value - "/provider", GET methods that returns the versions of the targeted resource.
static String	GET_REPORT Value - "/report", GET methods a report of regarding the promotion or the dependencies.
static String	GET_VERSIONS Value - "/versions", GET methods that returns the versions of the targeted resource.
static String	GROUPID_PARAM Value - "groupId", String query parameter used to filter artifacts.
static String	HAS_LICENSE_PARAM Value - "hasLicense", boolean query parameter used to filter artifacts.
static String	LICENSE_ID_PARAM Value - "licenseId", string query parameter used for licenses.
static String	LICENSE_RESOURCE Value - "license", License is a Grapes server resource that handles the information about license.
static String	MODULE_RESOURCE Value - "module", Module is a Grapes server resource that handles the information about modules.
static String	NAME_PARAM Value - "name", String query parameter used to filter modules.
static String	ORGANIZATION_PARAM Value - "organization", boolean query parameter used to filter modules.
static String	ORGANIZATION_RESOURCE Value - "organization", Organization is a Grapes server resource that handles the information about organization.
static String	PASSWORD_PARAM Value - "password", String query parameter used to add credentials.
static String	PRODUCT_RESOURCE Value - "product", Product is a Grapes server resource that handles the information about products & deliveries.
static String	PROMOTED_PARAM Value - "promoted", boolean query parameter used to filter modules or artifacts.
static String	PROMOTION Value - "/promotion", POST methods used as /module/{name}/{version}.
static String	PROVIDER_PARAM Value - "provider", String query parameter used to filter artifacts.
static String	RECURSIVE_PARAM Value - "fullRecursive", boolean query parameter that is used to get the result of the request going till the end of the dependency depth.
static String	SCOPE_COMPILE_PARAM Value - "scopeComp", boolean query parameter used to filter dependencies.
static String	SCOPE_PROVIDED_PARAM Value - "scopePro", boolean query parameter used to filter dependencies.
static String	SCOPE_RUNTIME_PARAM Value - "scopeRun", boolean query parameter used to filter dependencies.
static String	SCOPE_TEST_PARAM Value - "scopeTest", boolean query parameter used to filter dependencies.
static String	SEQUOIA_RESOURCE Value - "sequoia", Sequoia is a Grapes server provides graphs.
static String	SET_DO_NOT_USE Value - "/donotuse", POST/GET flag "DO_NOT_USE" for the targeted artifact.
static String	SHOW_ANCESTOR_PARAM Value - "showAncestors", boolean query parameter used to show the ancestors in reports.
static String	SHOW_CORPORATE_PARAM Value - "showCorporate", boolean query parameter used to showCorporate Dependencies.
static String	SHOW_LICENSE_COMMENT_PARAM Value - "showLicenseComments", boolean query parameter used to show the license comments in reports.
static String	SHOW_LICENSE_FULL_NAME_PARAM Value - "showLicenseFullNames", boolean query parameter used to show the license long names in reports.
static String	SHOW_LICENSE_PARAM Value - "showLicenses", boolean query parameter used to show the licenses in reports.
static String	SHOW_LICENSE_URL_PARAM Value - "showLicenseUrls", boolean query parameter used to show the license urls in reports.
static String	SHOW_PROVIDERS_PARAM Value - "showProviders", boolean query parameter used to show artifacts provider in reports.
static String	SHOW_SCOPE_PARAM Value - "showScopes", boolean query parameter used to show the scopes in reports.
static String	SHOW_SIZE Value - "showSize", boolean query parameter used to show the sizes in reports.
static String	SHOW_SOURCES_PARAM Value - "showSources", boolean query parameter used to show dependency sources in reports.
static String	SHOW_SOURCES_VERSION_PARAM Value - "showSourceVersions", boolean query parameter used to show dependency sources version in reports.
static String	SHOW_TARGET_PARAM Value - "showTargets", boolean query parameter used to show the target GAVC in reports.
static String	SHOW_TARGET_URL_PARAM Value - "showTargetUrls", boolean query parameter used to show the download URLs in reports.
static String	SHOW_THIRPARTY_PARAM Value - "showThirdparty", boolean query parameter used to show the ancestors in reports.
static String	TO_BE_VALIDATED_PARAM Value - "toBeValidated", boolean query parameter used to filter licenses that has to be validated.
static String	TO_UPDATE_PARAM Value - "toUpdate", boolean query parameter used to filter dependencies.
static String	TYPE_PARAM Value - "type", String query parameter used to filter artifacts.
static String	URL_PARAM Value - "url", String query parameter used to filter artifacts.
static String	USER_PARAM Value - "user", String query parameter used to add credentials.
static String	USER_ROLE_PARAM Value - "role", String query parameter used to add or remove user roles.
static String	VERSION_PARAM Value - "version", String query parameter used to filter artifacts.
static String	WEBAPP_RESOURCE Value - "webapp", Webapp is an UI that is over Grapes server server REST API.

Field Detail

ORGANIZATION_RESOURCE

static final String ORGANIZATION_RESOURCE

Value - "organization", Organization is a Grapes server resource that handles the information about organization.

See Also:

Constant Field Values

PRODUCT_RESOURCE

static final String PRODUCT_RESOURCE

Value - "product", Product is a Grapes server resource that handles the information about products & deliveries.

See Also:

Constant Field Values

MODULE_RESOURCE

static final String MODULE_RESOURCE

Value - "module", Module is a Grapes server resource that handles the information about modules.

See Also:

Constant Field Values

ARTIFACT_RESOURCE

static final String ARTIFACT_RESOURCE

Value - "artifact", Artifact is a Grapes server resource that handles the information about artifacts.

See Also:

Constant Field Values

LICENSE_RESOURCE

static final String LICENSE_RESOURCE

Value - "license", License is a Grapes server resource that handles the information about license.

See Also:

Constant Field Values

SEQUOIA_RESOURCE

static final String SEQUOIA_RESOURCE

Value - "sequoia", Sequoia is a Grapes server provides graphs.

See Also:

Constant Field Values

WEBAPP_RESOURCE

static final String WEBAPP_RESOURCE

Value - "webapp", Webapp is an UI that is over Grapes server server REST API.

See Also:

Constant Field Values

GET_DELIVERIES

static final String GET_DELIVERIES

Value - "/deliveries", GET methods that returns the deliveries of a product. Usually used as /product/{name}/.

See Also:

Constant Field Values

GET_MODULE

static final String GET_MODULE

Value - "/module", GET methods that returns the module of an artifact. Usually used as /artifact/{gavc}/.

See Also:

Constant Field Values

GET_MODULES

static final String GET_MODULES

Value - "/modules", GET methods that returns the modules of a product. Usually used as /product/{name}/.

See Also:

Constant Field Values

GET_CORPORATE_GROUPIDS

static final String GET_CORPORATE_GROUPIDS

Value - "/corporateGroupIds", GET methods that returns the list of corporate groupIds. Usually used as /organization/{name}/.

See Also:

Constant Field Values

GET_NAMES

static final String GET_NAMES

Value - "/names", GET methods that returns the names of the targeted resources. Usually used as /resourceName.

See Also:

Constant Field Values

GET_GAVCS

static final String GET_GAVCS

Value - "/gavcs", GET methods that returns the gavcs of the targeted artifacts. Used as /artifact.

See Also:

Constant Field Values

GET_GROUPIDS

static final String GET_GROUPIDS

Value - "/groupIds", GET methods that returns the groupids of the targeted artifacts. Used as /artifact.

See Also:

Constant Field Values

GET_VERSIONS

static final String GET_VERSIONS

Value - "/versions", GET methods that returns the versions of the targeted resource. Usually used as /resourceName/{resourceNameID}.

See Also:

Constant Field Values

GET_LAST_VERSION

static final String GET_LAST_VERSION

Value - "/lastversion", GET methods that returns the last version of the targeted resource. Usually used as /resourceName/{resourceNameID}.

See Also:

Constant Field Values

GET_DOWNLOAD_URL

static final String GET_DOWNLOAD_URL

Value - "/downloadurl", GET methods that returns the versions of the targeted resource. Usually used as /resourceName/{resourceNameID}.

See Also:

Constant Field Values

GET_PROVIDER

static final String GET_PROVIDER

Value - "/provider", GET methods that returns the versions of the targeted resource. Usually used as /resourceName/{resourceNameID}.

See Also:

Constant Field Values

PROMOTION

static final String PROMOTION

Value - "/promotion", POST methods used as /module/{name}/{version}.

See Also:

Constant Field Values

GET_FEASIBLE

static final String GET_FEASIBLE

Value - "/doable", POST methods used to know if the promotion can be done.

See Also:

Constant Field Values

GET_BUILD_INFO

static final String GET_BUILD_INFO

Value - "/buildInfo", GET methods that returns TRUE if the targeted module is promoted. Used as /module/{name}/{version}.

See Also:

Constant Field Values

GET_ANCESTORS

static final String GET_ANCESTORS

Value - "/ancestors", GET methods that returns the ancestor of the targeted resource. Usually used as /resourceName/{resourceUID}.

See Also:

Constant Field Values

GET_DEPENDENCIES

static final String GET_DEPENDENCIES

Value - "/dependencies", GET methods that returns the dependencies of the targeted resource. Usually used as /resourceName/{resourceUID}.

See Also:

Constant Field Values

GET_REPORT

static final String GET_REPORT

Value - "/report", GET methods a report of regarding the promotion or the dependencies. Usually used as /resourceName/{resourceUID}.

See Also:

Constant Field Values

GET_LICENSES

static final String GET_LICENSES

Value - "/licenses", GET methods that returns the licenses of the targeted resource. Usually used as /resourceName/{resourceUID}.

See Also:

Constant Field Values

GET_ORGANIZATION

static final String GET_ORGANIZATION

Value - "/organization", GET methods that returns the organization of an Artifact or a Module.

See Also:

Constant Field Values

SET_DO_NOT_USE

static final String SET_DO_NOT_USE

Value - "/donotuse", POST/GET flag "DO_NOT_USE" for the targeted artifact. Usually used as //{gavc}/?=.

See Also:

Constant Field Values

GET_ALL

static final String GET_ALL

Value - "/all", GET methods that retrieve all the elements of a resource type. Usually used as /.

See Also:

Constant Field Values

RECURSIVE_PARAM

static final String RECURSIVE_PARAM

Value - "fullRecursive", boolean query parameter that is used to get the result of the request going till the end of the dependency depth. Override depth parameter if exist.

See Also:

Constant Field Values

DEPTH_PARAM

static final String DEPTH_PARAM

Value - "depth", integer query parameter that is used to set a depth into the dependency result.

See Also:

Constant Field Values

APPROVED_PARAM

static final String APPROVED_PARAM

Value - "approved", boolean query parameter used for licenses.

See Also:

Constant Field Values

LICENSE_ID_PARAM

static final String LICENSE_ID_PARAM

Value - "licenseId", string query parameter used for licenses.

See Also:

Constant Field Values

PROMOTED_PARAM

static final String PROMOTED_PARAM

Value - "promoted", boolean query parameter used to filter modules or artifacts.

See Also:

Constant Field Values

ORGANIZATION_PARAM

static final String ORGANIZATION_PARAM

Value - "organization", boolean query parameter used to filter modules.

See Also:

Constant Field Values

SCOPE_COMPILE_PARAM

static final String SCOPE_COMPILE_PARAM

Value - "scopeComp", boolean query parameter used to filter dependencies.

See Also:

Constant Field Values

SCOPE_RUNTIME_PARAM

static final String SCOPE_RUNTIME_PARAM

Value - "scopeRun", boolean query parameter used to filter dependencies.

See Also:

Constant Field Values

SCOPE_PROVIDED_PARAM

static final String SCOPE_PROVIDED_PARAM

Value - "scopePro", boolean query parameter used to filter dependencies.

See Also:

Constant Field Values

SCOPE_TEST_PARAM

static final String SCOPE_TEST_PARAM

Value - "scopeTest", boolean query parameter used to filter dependencies.

See Also:

Constant Field Values

TO_UPDATE_PARAM

static final String TO_UPDATE_PARAM

Value - "toUpdate", boolean query parameter used to filter dependencies.

See Also:

Constant Field Values

HAS_LICENSE_PARAM

static final String HAS_LICENSE_PARAM

Value - "hasLicense", boolean query parameter used to filter artifacts.

See Also:

Constant Field Values

TO_BE_VALIDATED_PARAM

static final String TO_BE_VALIDATED_PARAM

Value - "toBeValidated", boolean query parameter used to filter licenses that has to be validated.

See Also:

Constant Field Values

SHOW_CORPORATE_PARAM

static final String SHOW_CORPORATE_PARAM

Value - "showCorporate", boolean query parameter used to showCorporate Dependencies.

See Also:

Constant Field Values

SHOW_LICENSE_PARAM

static final String SHOW_LICENSE_PARAM

Value - "showLicenses", boolean query parameter used to show the licenses in reports.

See Also:

Constant Field Values

SHOW_LICENSE_COMMENT_PARAM

static final String SHOW_LICENSE_COMMENT_PARAM

Value - "showLicenseComments", boolean query parameter used to show the license comments in reports.

See Also:

Constant Field Values

SHOW_LICENSE_URL_PARAM

static final String SHOW_LICENSE_URL_PARAM

Value - "showLicenseUrls", boolean query parameter used to show the license urls in reports.

See Also:

Constant Field Values

SHOW_LICENSE_FULL_NAME_PARAM

static final String SHOW_LICENSE_FULL_NAME_PARAM

Value - "showLicenseFullNames", boolean query parameter used to show the license long names in reports.

See Also:

Constant Field Values

SHOW_SIZE

static final String SHOW_SIZE

Value - "showSize", boolean query parameter used to show the sizes in reports.

See Also:

Constant Field Values

SHOW_TARGET_PARAM

static final String SHOW_TARGET_PARAM

Value - "showTargets", boolean query parameter used to show the target GAVC in reports.

See Also:

Constant Field Values

SHOW_TARGET_URL_PARAM

static final String SHOW_TARGET_URL_PARAM

Value - "showTargetUrls", boolean query parameter used to show the download URLs in reports.

See Also:

Constant Field Values

SHOW_SCOPE_PARAM

static final String SHOW_SCOPE_PARAM

Value - "showScopes", boolean query parameter used to show the scopes in reports.

See Also:

Constant Field Values

SHOW_ANCESTOR_PARAM

static final String SHOW_ANCESTOR_PARAM

Value - "showAncestors", boolean query parameter used to show the ancestors in reports.

See Also:

Constant Field Values

SHOW_THIRPARTY_PARAM

static final String SHOW_THIRPARTY_PARAM

Value - "showThirdparty", boolean query parameter used to show the ancestors in reports.

See Also:

Constant Field Values

SHOW_SOURCES_PARAM

static final String SHOW_SOURCES_PARAM

Value - "showSources", boolean query parameter used to show dependency sources in reports.

See Also:

Constant Field Values

SHOW_SOURCES_VERSION_PARAM

static final String SHOW_SOURCES_VERSION_PARAM

Value - "showSourceVersions", boolean query parameter used to show dependency sources version in reports.

See Also:

Constant Field Values

SHOW_PROVIDERS_PARAM

static final String SHOW_PROVIDERS_PARAM

Value - "showProviders", boolean query parameter used to show artifacts provider in reports.

See Also:

Constant Field Values

NAME_PARAM

static final String NAME_PARAM

Value - "name", String query parameter used to filter modules.

See Also:

Constant Field Values

GROUPID_PARAM

static final String GROUPID_PARAM

Value - "groupId", String query parameter used to filter artifacts.

See Also:

Constant Field Values

ARTIFACTID_PARAM

static final String ARTIFACTID_PARAM

Value - "artifactId", String query parameter used to filter artifacts.

See Also:

Constant Field Values

VERSION_PARAM

static final String VERSION_PARAM

Value - "version", String query parameter used to filter artifacts.

See Also:

Constant Field Values

TYPE_PARAM

static final String TYPE_PARAM

Value - "type", String query parameter used to filter artifacts.

See Also:

Constant Field Values

CLASSIFIER_PARAM

static final String CLASSIFIER_PARAM

Value - "classifier", String query parameter used to filter artifacts.

See Also:

Constant Field Values

EXTENSION_PARAM

static final String EXTENSION_PARAM

Value - "extension", String query parameter used to filter artifacts.

See Also:

Constant Field Values

USER_PARAM

static final String USER_PARAM

Value - "user", String query parameter used to add credentials.

See Also:

Constant Field Values

USER_ROLE_PARAM

static final String USER_ROLE_PARAM

Value - "role", String query parameter used to add or remove user roles.

See Also:

Constant Field Values

PASSWORD_PARAM

static final String PASSWORD_PARAM

Value - "password", String query parameter used to add credentials.

See Also:

Constant Field Values

DO_NOT_USE

static final String DO_NOT_USE

Value - "doNotUse", String query parameter used to filter/update the field "DO_NOT_USE" of an artifact.

See Also:

Constant Field Values

GAVC

static final String GAVC

Value - "gavc", String query parameter used to filter artifacts.

See Also:

Constant Field Values

URL_PARAM

static final String URL_PARAM

Value - "url", String query parameter used to filter artifacts.

See Also:

Constant Field Values

PROVIDER_PARAM

static final String PROVIDER_PARAM

Value - "provider", String query parameter used to filter artifacts.

See Also:

Constant Field Values