IoTivity C++ SDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
OIC::Service::CloudProp Class Reference

Data class stored for provisioning of coap cloud server properties. More...

Public Member Functions

 CloudProp ()
 Constructor. More...
 
 CloudProp (const CloudProp &cloudProp)
 
 CloudProp (const CloudProp &&cloudProp)
 
 CloudProp (const OCRepresentation &rep)
 Constructor with OCRepresentation object. More...
 
void setCloudProp (string authCode, string authProvider, string ciServer)
 Set CoapCloudConf resource properties to be delivered to Enrollee. More...
 
void setCloudPropWithAccessToken (string accessToken, OAUTH_TOKENTYPE tokenType, string authProvider, string ciServer)
 Set CoapCloudConf resource properties with Access token to be delivered to Enrollee. More...
 
void setCloudID (string cloudID)
 Set CloudServer's UUID. More...
 
void setCredID (int credID)
 Set CloudServer's credential ID of certificate. More...
 
std::string getAuthCode () const
 Get an auth code to be delivered. More...
 
std::string getAuthProvider () const
 Get an auth provider which issued an auth code. More...
 
std::string getCiServer () const
 Get a CI server to be delivered. More...
 
std::string getCloudID () const
 Get a CI server's Uuid to be delivered. More...
 
int getCredID () const
 Get a CI server's credential ID of certificate. More...
 
std::string getAccessToken () const
 Get an access token to be delivered. More...
 
OAUTH_TOKENTYPE getAccessTokenType () const
 Get an access token type to be delivered. More...
 
const OCRepresentationtoOCRepresentation () const
 Get OCRepresentation object. More...
 
void updateOCRepresentation (int specVersion)
 Update Cloud property representation as per OCF Specification. More...
 

Protected Attributes

OCRepresentation m_rep
 
std::string m_cloudID
 
int m_credID
 

Detailed Description

Data class stored for provisioning of coap cloud server properties.

Constructor & Destructor Documentation

OIC::Service::CloudProp::CloudProp ( )
inline

Constructor.

OIC::Service::CloudProp::CloudProp ( const CloudProp cloudProp)
inline
OIC::Service::CloudProp::CloudProp ( const CloudProp &&  cloudProp)
inline
OIC::Service::CloudProp::CloudProp ( const OCRepresentation rep)
inline

Constructor with OCRepresentation object.

This is used for JNI communication.

Parameters
repOCRepresentation object

Member Function Documentation

std::string OIC::Service::CloudProp::getAccessToken ( ) const
inline

Get an access token to be delivered.

Returns
an access token to be delivered.
OAUTH_TOKENTYPE OIC::Service::CloudProp::getAccessTokenType ( ) const
inline

Get an access token type to be delivered.

Returns
an access token type to be delivered.
std::string OIC::Service::CloudProp::getAuthCode ( ) const
inline

Get an auth code to be delivered.

Returns
an auth code to be delivered.
std::string OIC::Service::CloudProp::getAuthProvider ( ) const
inline

Get an auth provider which issued an auth code.

Returns
an auth provider which issued an auth code
std::string OIC::Service::CloudProp::getCiServer ( ) const
inline

Get a CI server to be delivered.

Returns
a CI server to be delivered
std::string OIC::Service::CloudProp::getCloudID ( ) const
inline

Get a CI server's Uuid to be delivered.

Returns
a CI server's Uuid to be delivered
int OIC::Service::CloudProp::getCredID ( ) const
inline

Get a CI server's credential ID of certificate.

Returns
a CI server's credential ID of certificated
void OIC::Service::CloudProp::setCloudID ( string  cloudID)
inline

Set CloudServer's UUID.

Parameters
cloudIDCloud Interface server's UUID
void OIC::Service::CloudProp::setCloudProp ( string  authCode,
string  authProvider,
string  ciServer 
)
inline

Set CoapCloudConf resource properties to be delivered to Enrollee.

Parameters
authCodeAuth code issued by OAuth2.0-compatible account server
authProviderAuth provider ID
ciServerCloud interface server URL which an Enrollee is going to registered
void OIC::Service::CloudProp::setCloudPropWithAccessToken ( string  accessToken,
OAUTH_TOKENTYPE  tokenType,
string  authProvider,
string  ciServer 
)
inline

Set CoapCloudConf resource properties with Access token to be delivered to Enrollee.

Parameters
accessTokenAccess token which is given in a return of auth code issued by OAuth2.0-compatible account server
tokenTypeAccess token type, i.e. "bearer"
authProviderAuth provider ID
ciServerCloud interface server URL which an Enrollee is going to registered
See Also
OAUTH_TOKENTYPE
void OIC::Service::CloudProp::setCredID ( int  credID)
inline

Set CloudServer's credential ID of certificate.

Parameters
credIDCloud Interface server's credential ID of certificate
const OCRepresentation& OIC::Service::CloudProp::toOCRepresentation ( ) const
inline

Get OCRepresentation object.

Returns
OCRepresentation object
void OIC::Service::CloudProp::updateOCRepresentation ( int  specVersion)
inline

Update Cloud property representation as per OCF Specification.

Resource Schema for CloudConf resource is different in older Enrollee following OIC Spec compared to newer Enrollee following OCF Spec. This function updates the representation as per spec version.

Member Data Documentation

std::string OIC::Service::CloudProp::m_cloudID
protected
int OIC::Service::CloudProp::m_credID
protected
OCRepresentation OIC::Service::CloudProp::m_rep
protected

The documentation for this class was generated from the following file: