Package com.cumulocity.sdk.client
Class PlatformImpl
- java.lang.Object
-
- com.cumulocity.sdk.client.PlatformParameters
-
- com.cumulocity.sdk.client.PlatformImpl
-
- All Implemented Interfaces:
Platform
,AutoCloseable
public class PlatformImpl extends PlatformParameters implements Platform
-
-
Field Summary
Fields Modifier and Type Field Description static String
CLIENT_PARAMETERS
static String
CUMOLOCITY_APPLICATION_KEY
static String
CUMOLOCITY_HOST
static String
CUMOLOCITY_PROXY_HOST
static String
CUMULOCITY_PAGE_SIZE
static String
CUMULOCITY_PASSWORD
static String
CUMULOCITY_PORT
static String
CUMULOCITY_PROXY_PASSWORD
static String
CUMULOCITY_PROXY_PORT
static String
CUMULOCITY_PROXY_USER
static String
CUMULOCITY_TENANT
static String
CUMULOCITY_USER
-
Fields inherited from class com.cumulocity.sdk.client.PlatformParameters
DEFAULT_PAGE_SIZE
-
-
Constructor Summary
Constructors Constructor Description PlatformImpl()
PlatformImpl(String host, int port, CumulocityCredentials credentials)
PlatformImpl(String host, int port, CumulocityCredentials credentials, int pageSize)
PlatformImpl(String host, CumulocityCredentials credentials)
PlatformImpl(String host, CumulocityCredentials credentials, int pageSize)
PlatformImpl(String host, CumulocityCredentials credentials, ClientConfiguration clientConfiguration)
PlatformImpl(String host, CumulocityCredentials credentials, ClientConfiguration clientConfiguration, int pageSize)
PlatformImpl(String host, String tenantId, String user, String password, String applicationKey)
Deprecated.PlatformImpl(String host, String tenantId, String user, String password, String applicationKey, int pageSize)
Deprecated.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static Platform
createPlatform()
This static method creates the Platform from the system parameters.protected void
finalize()
AlarmApi
getAlarmApi()
AuditRecordApi
getAuditRecordApi()
BinariesApi
getBinariesApi()
DeviceControlApi
getDeviceControlApi()
DeviceCredentialsApi
getDeviceCredentialsApi()
EventApi
getEventApi()
IdentityApi
getIdentityApi()
InventoryApi
getInventoryApi()
MeasurementApi
getMeasurementApi()
NotificationSubscriptionApi
getNotificationSubscriptionApi()
SystemOptionApi
getSystemOptionApi()
TenantOptionApi
getTenantOptionApi()
TokenApi
getTokenApi()
UserApi
getUserApi()
RestConnector
rest()
-
Methods inherited from class com.cumulocity.sdk.client.PlatformParameters
close, createRestConnector, getApplicationKey, getChunkedEncodingSize, getHost, getHttpClientConfig, getPageSize, getProxyHost, getProxyPassword, getProxyPort, getProxyUserId, getRequestOrigin, getResponseMapper, getTenantId, getTfaToken, getUser, isAlwaysCloseConnection, isForceInitialHost, registerInterceptor, requireResponseBody, setAlwaysCloseConnection, setChunkedEncodingSize, setForceInitialHost, setHost, setHttpClientConfig, setProxyHost, setProxyPassword, setProxyPort, setProxyUserId, setRequireResponseBody, setResponseMapper, setTfaToken, setTfaToken, unregisterInterceptor
-
-
-
-
Field Detail
-
CLIENT_PARAMETERS
public static final String CLIENT_PARAMETERS
- See Also:
- Constant Field Values
-
CUMULOCITY_PAGE_SIZE
public static final String CUMULOCITY_PAGE_SIZE
- See Also:
- Constant Field Values
-
CUMULOCITY_PASSWORD
public static final String CUMULOCITY_PASSWORD
- See Also:
- Constant Field Values
-
CUMULOCITY_USER
public static final String CUMULOCITY_USER
- See Also:
- Constant Field Values
-
CUMULOCITY_TENANT
public static final String CUMULOCITY_TENANT
- See Also:
- Constant Field Values
-
CUMULOCITY_PORT
public static final String CUMULOCITY_PORT
- See Also:
- Constant Field Values
-
CUMOLOCITY_HOST
public static final String CUMOLOCITY_HOST
- See Also:
- Constant Field Values
-
CUMOLOCITY_APPLICATION_KEY
public static final String CUMOLOCITY_APPLICATION_KEY
- See Also:
- Constant Field Values
-
CUMOLOCITY_PROXY_HOST
public static final String CUMOLOCITY_PROXY_HOST
- See Also:
- Constant Field Values
-
CUMULOCITY_PROXY_PORT
public static final String CUMULOCITY_PROXY_PORT
- See Also:
- Constant Field Values
-
CUMULOCITY_PROXY_USER
public static final String CUMULOCITY_PROXY_USER
- See Also:
- Constant Field Values
-
CUMULOCITY_PROXY_PASSWORD
public static final String CUMULOCITY_PROXY_PASSWORD
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
PlatformImpl
public PlatformImpl(String host, CumulocityCredentials credentials)
-
PlatformImpl
public PlatformImpl(String host, CumulocityCredentials credentials, ClientConfiguration clientConfiguration)
-
PlatformImpl
public PlatformImpl(String host, int port, CumulocityCredentials credentials)
-
PlatformImpl
public PlatformImpl(String host, CumulocityCredentials credentials, int pageSize)
-
PlatformImpl
public PlatformImpl(String host, CumulocityCredentials credentials, ClientConfiguration clientConfiguration, int pageSize)
-
PlatformImpl
public PlatformImpl(String host, int port, CumulocityCredentials credentials, int pageSize)
-
PlatformImpl
@Deprecated public PlatformImpl(String host, String tenantId, String user, String password, String applicationKey)
Deprecated.
-
PlatformImpl
@Deprecated public PlatformImpl(String host, String tenantId, String user, String password, String applicationKey, int pageSize)
Deprecated.
-
PlatformImpl
public PlatformImpl()
-
-
Method Detail
-
createPlatform
public static Platform createPlatform() throws SDKException
This static method creates the Platform from the system parameters.System Properties cumolocityHost : ip address or name of the Cumulocity server cumulocityPort : port number of the Cumulocity server; cumulocityTenant : Tenant ID ; cumulocityUser : User ID ; cumulocityPassword : Password ; cumulocityPageSize : Page size for the paging parameters.
proxyHost : Proxy Host Name; proxyPort : Proxy Port Name proxyUser : Proxy User Name proxyPassword : Proxy Password
- Returns:
- Platform for the handle to get other methods.
- Throws:
SDKException
- when platform creation fails
-
getInventoryApi
public InventoryApi getInventoryApi() throws SDKException
- Specified by:
getInventoryApi
in interfacePlatform
- Throws:
SDKException
-
getIdentityApi
public IdentityApi getIdentityApi() throws SDKException
- Specified by:
getIdentityApi
in interfacePlatform
- Throws:
SDKException
-
getMeasurementApi
public MeasurementApi getMeasurementApi() throws SDKException
- Specified by:
getMeasurementApi
in interfacePlatform
- Throws:
SDKException
-
getDeviceControlApi
public DeviceControlApi getDeviceControlApi() throws SDKException
- Specified by:
getDeviceControlApi
in interfacePlatform
- Throws:
SDKException
-
getEventApi
public EventApi getEventApi() throws SDKException
- Specified by:
getEventApi
in interfacePlatform
- Throws:
SDKException
-
getAlarmApi
public AlarmApi getAlarmApi() throws SDKException
- Specified by:
getAlarmApi
in interfacePlatform
- Throws:
SDKException
-
getAuditRecordApi
public AuditRecordApi getAuditRecordApi() throws SDKException
- Specified by:
getAuditRecordApi
in interfacePlatform
- Throws:
SDKException
-
getDeviceCredentialsApi
public DeviceCredentialsApi getDeviceCredentialsApi() throws SDKException
- Specified by:
getDeviceCredentialsApi
in interfacePlatform
- Throws:
SDKException
-
getBinariesApi
public BinariesApi getBinariesApi() throws SDKException
- Specified by:
getBinariesApi
in interfacePlatform
- Throws:
SDKException
-
getUserApi
public UserApi getUserApi() throws SDKException
- Specified by:
getUserApi
in interfacePlatform
- Throws:
SDKException
-
getTenantOptionApi
public TenantOptionApi getTenantOptionApi() throws SDKException
- Specified by:
getTenantOptionApi
in interfacePlatform
- Throws:
SDKException
-
getSystemOptionApi
public SystemOptionApi getSystemOptionApi() throws SDKException
- Specified by:
getSystemOptionApi
in interfacePlatform
- Throws:
SDKException
-
getTokenApi
public TokenApi getTokenApi() throws SDKException
- Specified by:
getTokenApi
in interfacePlatform
- Throws:
SDKException
-
getNotificationSubscriptionApi
public NotificationSubscriptionApi getNotificationSubscriptionApi() throws SDKException
- Specified by:
getNotificationSubscriptionApi
in interfacePlatform
- Throws:
SDKException
-
finalize
protected void finalize() throws Throwable
-
rest
public RestConnector rest()
-
-