Class IdentityApiImpl
- java.lang.Object
-
- com.cumulocity.sdk.client.identity.IdentityApiImpl
-
- All Implemented Interfaces:
IdentityApi
public class IdentityApiImpl extends Object implements IdentityApi
-
-
Constructor Summary
Constructors Constructor Description IdentityApiImpl(RestConnector restConnector, TemplateUrlParser templateUrlParser, IdentityRepresentation identityRepresentation, int pageSize)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description ExternalIDRepresentation
create(ExternalIDRepresentation representation)
Creates an association between the external id and its global id in the platform.void
deleteExternalId(ExternalIDRepresentation extIdRep)
Deletes between the external id and its global id in the platform.ExternalIDRepresentation
getExternalId(ID extId)
Gets external id representation from the platform by the given external id.ExternalIDCollection
getExternalIdsOfGlobalId(GId gid)
Gets the external ids associated with the given global id
-
-
-
Constructor Detail
-
IdentityApiImpl
public IdentityApiImpl(RestConnector restConnector, TemplateUrlParser templateUrlParser, IdentityRepresentation identityRepresentation, int pageSize)
-
-
Method Detail
-
getExternalId
public ExternalIDRepresentation getExternalId(ID extId) throws SDKException
Description copied from interface:IdentityApi
Gets external id representation from the platform by the given external id. The returned external id contains the managed object. The global id associated with the given external id can be extracted from that managed object- Specified by:
getExternalId
in interfaceIdentityApi
- Parameters:
extId
- id of the event to search for- Returns:
- the external id representation including the managed object
- Throws:
SDKException
- if the external id is not found or if the query failed
-
deleteExternalId
public void deleteExternalId(ExternalIDRepresentation extIdRep) throws SDKException
Description copied from interface:IdentityApi
Deletes between the external id and its global id in the platform.- Specified by:
deleteExternalId
in interfaceIdentityApi
- Parameters:
extIdRep
- the external id to be deleted- Throws:
SDKException
- if the external could not be deleted
-
getExternalIdsOfGlobalId
public ExternalIDCollection getExternalIdsOfGlobalId(GId gid) throws SDKException
Description copied from interface:IdentityApi
Gets the external ids associated with the given global id- Specified by:
getExternalIdsOfGlobalId
in interfaceIdentityApi
- Parameters:
gid
- the global of the external ids to search for- Returns:
- a collection of external ids with paging functionality
- Throws:
SDKException
- if the query failed
-
create
public ExternalIDRepresentation create(ExternalIDRepresentation representation) throws SDKException
Description copied from interface:IdentityApi
Creates an association between the external id and its global id in the platform.- Specified by:
create
in interfaceIdentityApi
- Parameters:
representation
- the external to be created- Returns:
- the created external id
- Throws:
SDKException
- if the external id could not be created
-
-