Top Description Inners Fields Constructors Methods
org.osgi.service.onem2m.dto

public Class RequestPrimitiveDTO

extends DTO
Class Inheritance
Imports
java.util.List, org.osgi.dto.DTO

DTO expresses Request Primitive.
See Also
oneM2M TS-0004 6.4.1, oneM2M XSD requestPrimitive

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
RequestPrimitiveDTO.DesiredIdentifierResultType

Enum for DesiredIdentifierResultType

public static enum
RequestPrimitiveDTO.Operation

enum type for Operation

public static enum
RequestPrimitiveDTO.ResultContent

enum type for Result Content

Field Summary

Modifier and TypeField and Description
public Boolean
authorizationRelationshipIndicator

Authorization Relationship Indicator

public Boolean
authorizationSignatureIndicator

Authorization Signature Indicator

public List<String>
authorizationSignatures

Authorization Signatures

In oneM2M this parameter is expressed in m2m:signatureList.

public PrimitiveContentDTO
content

Primitive Content

public Boolean
deliveryAggregation

Delivery Aggregation

This parameter is related to CMDH(Communication Management and Delivery Handling) policy.

public RequestPrimitiveDTO.DesiredIdentifierResultType
desiredIdentifierResultType

Desired Identifier Result Type

This parameter specifies identifier type in response, such as structured or unstructured.

public Integer
eventCategory

Event Category

allowed values are 2(Immediate), 3(BestEffort), 4(Latest), and 100-999 as user defined range.

public FilterCriteriaDTO
filterCriteria

Filter Criteria

public String
from

From Parameter.

public String
groupRequestIdentifier

Group Request Identifier TODO: search doc.

public List<String>
groupRequestTargetMembers

Group Request Target Members

public List<String>
localTokenIDs

Local Token Identifiers

In oneM2M this parameter is expressed as list of xs:NCName.

public RequestPrimitiveDTO.Operation
operation

Operation This field is mandatory.

public String
operationExecutionTime

Operation Execution Time

public String
originatingTimestamp

Originating Timestamp

public ReleaseVersion
releaseVersionIndicator

Release Version

public String
requestExpirationTimestamp

Request Expiration Timestamp

* This parameter is related to CMDH(Communication Management and Delivery Handling) policy.

public String
requestIdentifier

Request Identifier

public Integer
resourceType

Resource Type

public ResponseTypeInfoDTO
responseType

Response Type Info

public RequestPrimitiveDTO.ResultContent
resultContent

Result Content

public String
resultExpirationTimestamp

Result Expiration Timestamp

This parameter is related to CMDH(Communication Management and Delivery Handling) policy.

public String
resultPersistence

Result Persistence

This parameter is related to CMDH(Communication Management and Delivery Handling) policy.

public List<String>
roleIDs

Role IDs

public Boolean
semanticQueryIndicator

Semantic Query Indicator

public String
to

To Parameter

public List<String>
tokenIDs

Token Identifiers

In oneM2M this parameter is expressed as list of m2m:tokenID.

public Boolean
tokenRequestIndicator

Token Request Indicator

public List<String>
tokens

Tokens

Each token is in m2m:dynAuthJWT

public String
vendorInformation

Vendor Information

Used for vendor specific information.

Constructor Summary

AccessConstructor and Description
public

Method Summary

Inherited from org.osgi.dto.DTO:
toString

Field Detail

authorizationRelationshipIndicatorback to summary
public Boolean authorizationRelationshipIndicator

Authorization Relationship Indicator

authorizationSignatureIndicatorback to summary
public Boolean authorizationSignatureIndicator

Authorization Signature Indicator

authorizationSignaturesback to summary
public List<String> authorizationSignatures

Authorization Signatures

In oneM2M this parameter is expressed in m2m:signatureList.

See Also
oneM2M TS-0004 6.3.4.2.8, oneM2M XSD signatureList
contentback to summary
public PrimitiveContentDTO content

Primitive Content

See Also
oneM2M TS-0004 6.3.5.5, oneM2M TS-0004 7.2.1.1
deliveryAggregationback to summary
public Boolean deliveryAggregation

Delivery Aggregation

This parameter is related to CMDH(Communication Management and Delivery Handling) policy.

See Also
oneM2M TS-0004 D.12
desiredIdentifierResultTypeback to summary
public RequestPrimitiveDTO.DesiredIdentifierResultType desiredIdentifierResultType

Desired Identifier Result Type

This parameter specifies identifier type in response, such as structured or unstructured. This parameter used to be Discovery Result Type in previous oneM2M release.

See Also
oneM2M TS-0004 6.3.4.2.8
eventCategoryback to summary
public Integer eventCategory

Event Category

allowed values are 2(Immediate), 3(BestEffort), 4(Latest), and 100-999 as user defined range.

See Also
oneM2M TS-0004 6.3.3, oneM2M XSD eventCat, oneM2M XSD stdEventCats
filterCriteriaback to summary
public FilterCriteriaDTO filterCriteria

Filter Criteria

See Also
oneM2M TS-0004 6.3.5.8
fromback to summary
public String from

From Parameter.

Originator of the request is stored.

See Also
oneM2M TS-0004 6.3.4.2.5
groupRequestIdentifierback to summary
public String groupRequestIdentifier

Group Request Identifier TODO: search doc.

groupRequestTargetMembersback to summary
public List<String> groupRequestTargetMembers

Group Request Target Members

localTokenIDsback to summary
public List<String> localTokenIDs

Local Token Identifiers

In oneM2M this parameter is expressed as list of xs:NCName.

operationback to summary
public RequestPrimitiveDTO.Operation operation

Operation This field is mandatory.

See Also
oneM2M TS-0004 6.3.4.2.5
operationExecutionTimeback to summary
public String operationExecutionTime

Operation Execution Time

originatingTimestampback to summary
public String originatingTimestamp

Originating Timestamp

releaseVersionIndicatorback to summary
public ReleaseVersion releaseVersionIndicator

Release Version

requestExpirationTimestampback to summary
public String requestExpirationTimestamp

Request Expiration Timestamp

* This parameter is related to CMDH(Communication Management and Delivery Handling) policy.

See Also
oneM2M TS-0004 D.12
requestIdentifierback to summary
public String requestIdentifier

Request Identifier

See Also
oneM2M TS-0004 6.3.3
resourceTypeback to summary
public Integer resourceType

Resource Type

See Also
oneM2M TS-0004 6.3.4.2.1
responseTypeback to summary
public ResponseTypeInfoDTO responseType

Response Type Info

See Also
oneM2M TS-0004 6.3.5.30
resultContentback to summary
public RequestPrimitiveDTO.ResultContent resultContent

Result Content

See Also
oneM2M TS-0004 6.3.4.2.7
resultExpirationTimestampback to summary
public String resultExpirationTimestamp

Result Expiration Timestamp

This parameter is related to CMDH(Communication Management and Delivery Handling) policy.

See Also
oneM2M TS-0004 D.12
resultPersistenceback to summary
public String resultPersistence

Result Persistence

This parameter is related to CMDH(Communication Management and Delivery Handling) policy.

See Also
oneM2M TS-0004 D.12
roleIDsback to summary
public List<String> roleIDs

Role IDs

semanticQueryIndicatorback to summary
public Boolean semanticQueryIndicator

Semantic Query Indicator

See Also
oneM2M TS-0004 7.3.3.19
toback to summary
public String to

To Parameter

tokenIDsback to summary
public List<String> tokenIDs

Token Identifiers

In oneM2M this parameter is expressed as list of m2m:tokenID.

See Also
oneM2M XSD signatureList
tokenRequestIndicatorback to summary
public Boolean tokenRequestIndicator

Token Request Indicator

tokensback to summary
public List<String> tokens

Tokens

Each token is in m2m:dynAuthJWT

See Also
oneM2M XSD signatureList
vendorInformationback to summary
public String vendorInformation

Vendor Information

Used for vendor specific information. No procedure is defined for the parameter.

Constructor Detail

RequestPrimitiveDTOback to summary
public RequestPrimitiveDTO()
org.osgi.service.onem2m.dto back to summary

public final Enum RequestPrimitiveDTO.DesiredIdentifierResultType

extends Enum<RequestPrimitiveDTO.DesiredIdentifierResultType>
Class Inheritance

Enum for DesiredIdentifierResultType
See Also
oneM2M TS-0004 6.3.4.2.8

Field Summary

Modifier and TypeField and Description
public static final RequestPrimitiveDTO.DesiredIdentifierResultType
structured

structured

public static final RequestPrimitiveDTO.DesiredIdentifierResultType
unstructured

unstructured

private final int

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

The result type value.
getValue
()

Return result type value.

public static RequestPrimitiveDTO.DesiredIdentifierResultType
public static RequestPrimitiveDTO.DesiredIdentifierResultType[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

structuredback to summary
public static final RequestPrimitiveDTO.DesiredIdentifierResultType structured

structured

unstructuredback to summary
public static final RequestPrimitiveDTO.DesiredIdentifierResultType unstructured

unstructured

valueback to summary
private final int value

Constructor Detail

DesiredIdentifierResultTypeback to summary
private DesiredIdentifierResultType(int i)

Method Detail

getValueback to summary
public int getValue()

Return result type value.

Returns:int

The result type value.

valueOfback to summary
public static RequestPrimitiveDTO.DesiredIdentifierResultType valueOf(String name)
valuesback to summary
public static RequestPrimitiveDTO.DesiredIdentifierResultType[] values()
org.osgi.service.onem2m.dto back to summary

public final Enum RequestPrimitiveDTO.Operation

extends Enum<RequestPrimitiveDTO.Operation>
Class Inheritance

enum type for Operation
See Also
oneM2M XSD resultContent

Field Summary

Modifier and TypeField and Description
public static final RequestPrimitiveDTO.Operation
Create

Create

public static final RequestPrimitiveDTO.Operation
Delete

Delete

public static final RequestPrimitiveDTO.Operation
Notify

Notify

public static final RequestPrimitiveDTO.Operation
Retrieve

Retrieve

public static final RequestPrimitiveDTO.Operation
Update

Update

private final int

Constructor Summary

AccessConstructor and Description
private
Operation(int i)

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

assigned integer value
getValue
()

get assigned integer value

public static RequestPrimitiveDTO.Operation
public static RequestPrimitiveDTO.Operation[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

Createback to summary
public static final RequestPrimitiveDTO.Operation Create

Create

Deleteback to summary
public static final RequestPrimitiveDTO.Operation Delete

Delete

Notifyback to summary
public static final RequestPrimitiveDTO.Operation Notify

Notify

Retrieveback to summary
public static final RequestPrimitiveDTO.Operation Retrieve

Retrieve

Updateback to summary
public static final RequestPrimitiveDTO.Operation Update

Update

valueback to summary
private final int value

Constructor Detail

Operationback to summary
private Operation(int i)

Method Detail

getValueback to summary
public int getValue()

get assigned integer value

Returns:int

assigned integer value

valueOfback to summary
public static RequestPrimitiveDTO.Operation valueOf(String name)
valuesback to summary
public static RequestPrimitiveDTO.Operation[] values()
org.osgi.service.onem2m.dto back to summary

public final Enum RequestPrimitiveDTO.ResultContent

extends Enum<RequestPrimitiveDTO.ResultContent>
Class Inheritance

enum type for Result Content
See Also
oneM2M XSD resultContent

Field Summary

Modifier and TypeField and Description
public static final RequestPrimitiveDTO.ResultContent
attributes

attributes

public static final RequestPrimitiveDTO.ResultContent
attributesAndChildResourceReferences

attributesAndChildResourceReferences

public static final RequestPrimitiveDTO.ResultContent
attributesAndChildResources

attributesAndChildResources

public static final RequestPrimitiveDTO.ResultContent
childResourceReferences

childResourceReferences

public static final RequestPrimitiveDTO.ResultContent
childResources

childResources

public static final RequestPrimitiveDTO.ResultContent
hierarchicalAddress

hierarchicalAddress

public static final RequestPrimitiveDTO.ResultContent
hierarchicalAddressAndAttributes

hierarchicalAddressAndAttributes

public static final RequestPrimitiveDTO.ResultContent
nothing

nothing

public static final RequestPrimitiveDTO.ResultContent
originalResource

originalResource

private final int

Constructor Summary

AccessConstructor and Description
private

Method Summary

Modifier and TypeMethod and Description
public int

Returns:

assigned integer value
getValue
()

get assigned integer value

public static RequestPrimitiveDTO.ResultContent
public static RequestPrimitiveDTO.ResultContent[]
Inherited from java.lang.Enum:
clonecompareTodescribeConstableequalsfinalizegetDeclaringClasshashCodenameordinaltoStringvalueOf

Field Detail

attributesback to summary
public static final RequestPrimitiveDTO.ResultContent attributes

attributes

attributesAndChildResourceReferencesback to summary
public static final RequestPrimitiveDTO.ResultContent attributesAndChildResourceReferences

attributesAndChildResourceReferences

attributesAndChildResourcesback to summary
public static final RequestPrimitiveDTO.ResultContent attributesAndChildResources

attributesAndChildResources

childResourceReferencesback to summary
public static final RequestPrimitiveDTO.ResultContent childResourceReferences

childResourceReferences

childResourcesback to summary
public static final RequestPrimitiveDTO.ResultContent childResources

childResources

hierarchicalAddressback to summary
public static final RequestPrimitiveDTO.ResultContent hierarchicalAddress

hierarchicalAddress

hierarchicalAddressAndAttributesback to summary
public static final RequestPrimitiveDTO.ResultContent hierarchicalAddressAndAttributes

hierarchicalAddressAndAttributes

nothingback to summary
public static final RequestPrimitiveDTO.ResultContent nothing

nothing

originalResourceback to summary
public static final RequestPrimitiveDTO.ResultContent originalResource

originalResource

valueback to summary
private final int value

Constructor Detail

ResultContentback to summary
private ResultContent(int i)

Method Detail

getValueback to summary
public int getValue()

get assigned integer value

Returns:int

assigned integer value

valueOfback to summary
public static RequestPrimitiveDTO.ResultContent valueOf(String name)
valuesback to summary
public static RequestPrimitiveDTO.ResultContent[] values()