orca.shirako.api
Interface ISlice

All Known Implementing Classes:

AuthorityCodSlice, CodSlice, Slice

public interface ISlice

ISlice describes the programming interface to a slice object.

Method Summary

Slice	cloneRequest() Makes a minimal clone of this slice object sufficient for cross-actor calls.
java.util.Properties	getConfigurationProperties() Returns the slice configuration properties list (byte reference).
IController	getController() Returns the slice controller.
java.lang.String	getDescription() Returns the slice description.
java.util.Properties	getLocalProperties() Returns the slice local properties list (by reference).
java.lang.String	getName() Returns the slice name.
AuthToken	getOwner() Returns the slice owner.
java.util.Properties	getRequestProperties() Returns the slice request properties list (by reference).
ResourceData	getResourceData() Returns the slice properties.
java.util.Properties	getResourceProperties() Returns the slice resource properties list (by reference).
ResourceType	getResourceType() Returns the resource type of the slice.
SliceID	getSliceID() Returns the slice identifier.
Guard	Guard() Returns the slice guard.
boolean	isBrokerClient() Checks if the slice is a broker client slice (a client slice within an authority that represents a broker).
boolean	isClient() Checks if the slice is a client slice.
boolean	isInventory() Checks if the slice is an inventory slice.
void	setBrokerClient() Marks the slice as a broker client slice (a client slice within an authority that represents a broker).
void	setClient() Marks the slice as a client slice.
void	setController(IController controller) Attaches the controller for the slice.
void	setDescription(java.lang.String description) Sets the slice description.
void	setGuard(Guard g) Sets the slice guard.
void	setInventory(boolean value) Controls the inventory flag.
void	setName(java.lang.String name) Sets the slice name.
void	setOwner(AuthToken auth) Sets the slice owner.
void	setResourceData(ResourceData rsrcdata) Sets the slice properties.
void	setResourceType(ResourceType resourceType) Sets the slice resource type.

Method Detail

cloneRequest

Slice cloneRequest()

Makes a minimal clone of this slice object sufficient for cross-actor calls.

Returns:

a slice object to use when making cross-actor calls.

getLocalProperties

java.util.Properties getLocalProperties()

Returns the slice local properties list (by reference).

Returns:

local properties list

getRequestProperties

java.util.Properties getRequestProperties()

Returns the slice request properties list (by reference).

Returns:

request properties list

getResourceProperties

java.util.Properties getResourceProperties()

Returns the slice resource properties list (by reference).

Returns:

resource properties list

getConfigurationProperties

java.util.Properties getConfigurationProperties()

Returns the slice configuration properties list (byte reference).

Returns:

configuration properties list

setInventory

void setInventory(boolean value)

Controls the inventory flag.

Parameters:

value - inventory status: true, inventory slice, false, client slice

isInventory

boolean isInventory()

Checks if the slice is an inventory slice.

Returns:

true if the slice is an inventory slice

isClient

boolean isClient()

Checks if the slice is a client slice.

Returns:

true if the slice is a client slice

setClient

void setClient()

Marks the slice as a client slice.

isBrokerClient

boolean isBrokerClient()

Checks if the slice is a broker client slice (a client slice within an authority that represents a broker).

Returns:

true if the slice is a broker client slice

setBrokerClient

void setBrokerClient()

Marks the slice as a broker client slice (a client slice within an authority that represents a broker).

getName

java.lang.String getName()

Returns the slice name.

Returns:

slice name

setName

void setName(java.lang.String name)

Sets the slice name.

Parameters:

name - slice name to set

setOwner

void setOwner(AuthToken auth)

Sets the slice owner.

Parameters:

auth - the slice owner

getOwner

AuthToken getOwner()

Returns the slice owner.

Returns:

slice owner

setGuard

void setGuard(Guard g)

Sets the slice guard.

Parameters:

g - the guard

Guard

Guard Guard()

Returns the slice guard.

Returns:

the guard

getResourceData

ResourceData getResourceData()

Returns the slice properties.

Returns:

the properties

setResourceData

void setResourceData(ResourceData rsrcdata)

Sets the slice properties.

Parameters:

properties - the properties

getDescription

java.lang.String getDescription()

Returns the slice description.

Returns:

the description

setDescription

void setDescription(java.lang.String description)

Sets the slice description.

Parameters:

description - the description

setController

void setController(IController controller)

Attaches the controller for the slice.

Parameters:

controller - slice controller

getController

IController getController()

Returns the slice controller.

Returns:

slice controller

getResourceType

ResourceType getResourceType()

Returns the resource type of the slice.

Returns:

slice resource type

setResourceType

void setResourceType(ResourceType resourceType)

Sets the slice resource type.

Parameters:

resourceType - resource type

getSliceID

SliceID getSliceID()

Returns the slice identifier.

Returns:

slice identifier