org.apache.hadoop.yarn.api.records
Interface ContainerToken

All Known Implementing Classes:

ContainerTokenPBImpl

@InterfaceAudience.Public
@InterfaceStability.Stable
public interface ContainerToken

ContainerToken is the security token used by the framework to verify authenticity of any Container.

The ResourceManager, on container allocation provides a secure token which is verified by the NodeManager on container launch.

Applications do not need to care about ContainerToken, they are transparently handled by the framework - the allocated Container includes the ContainerToken.

See Also:

AMRMProtocol.allocate(org.apache.hadoop.yarn.api.protocolrecords.AllocateRequest), ContainerManager.startContainer(org.apache.hadoop.yarn.api.protocolrecords.StartContainerRequest)

Method Summary

ByteBuffer	getIdentifier() Get the token identifier.
String	getKind() Get the token kind.
ByteBuffer	getPassword() Get the token password
String	getService() Get the service to which the token is allocated.
void	setIdentifier(ByteBuffer identifier)
void	setKind(String kind)
void	setPassword(ByteBuffer password)
void	setService(String service)

Method Detail

getIdentifier

@InterfaceAudience.Public
@InterfaceStability.Stable
ByteBuffer getIdentifier()

Get the token identifier.

Returns:

token identifier

setIdentifier

@InterfaceAudience.Private
@InterfaceStability.Stable
void setIdentifier(ByteBuffer identifier)

getPassword

@InterfaceAudience.Public
@InterfaceStability.Stable
ByteBuffer getPassword()

Get the token password

Returns:

token password

setPassword

@InterfaceAudience.Private
@InterfaceStability.Stable
void setPassword(ByteBuffer password)

getKind

@InterfaceAudience.Public
@InterfaceStability.Stable
String getKind()

Get the token kind.

Returns:

token kind

setKind

@InterfaceAudience.Private
@InterfaceStability.Stable
void setKind(String kind)

getService

@InterfaceAudience.Public
@InterfaceStability.Stable
String getService()

Get the service to which the token is allocated.

Returns:

service to which the token is allocated

setService

@InterfaceAudience.Private
@InterfaceStability.Stable
void setService(String service)