org.onosproject.yms.ych

Interface YangCompositeEncoding

public interface YangCompositeEncoding

Abstraction of an entity which has the composite protocol request.

Protocols like RESTCONF, have split the schema specific information across different components in the protocol encoding.

There is a resource identifier, which is part of the RESTCONF request URL. and there is the information about the resource being operated on in the request, this is part of the request body.

Method Summary

Modifier and Type	Method and Description
String	getResourceIdentifier() Retrieves the resource identifier on which the operation is being performed.
YangResourceIdentifierType	getResourceIdentifierType() Retrieves the representation format of the resource identifier.
String	getResourceInformation() Retrieves the resource information in the protocol encoding format.
void	setResourceIdentifier(String resourceId) Sets resource identifier.
void	setResourceIdentifierType(YangResourceIdentifierType idType) Sets the resource identifier type.
void	setResourceInformation(String resourceInfo) Sets the resource information.

Method Detail

getResourceIdentifier

String getResourceIdentifier()

Retrieves the resource identifier on which the operation is being performed.

Returns:

the string representation of the resource being identified

getResourceIdentifierType

YangResourceIdentifierType getResourceIdentifierType()

Retrieves the representation format of the resource identifier.

Returns:

the type of the resource identifier

getResourceInformation

String getResourceInformation()

Retrieves the resource information in the protocol encoding format.

Returns:

the resource information in the protocol encoding format

setResourceIdentifier

void setResourceIdentifier(String resourceId)

Sets resource identifier.

Parameters:

resourceId - resource identifier

setResourceInformation

void setResourceInformation(String resourceInfo)

Sets the resource information.

Parameters:

resourceInfo - resource information

setResourceIdentifierType

void setResourceIdentifierType(YangResourceIdentifierType idType)

Sets the resource identifier type.

Parameters:

idType - resource identifier