All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface com.ibm.smt.client.Resource

public interface Resource
The Resource interface is a common parent interface for Channels and Things.


Variable Index

 o COPYRIGHT
 o DESTROYERS
Destroyers property name.
 o OBTAINERS
Obtainers property name.
 o WRITERS
Writers property name.

Method Index

 o destroy(String)
Destroys the resource.
 o getAccessControl()
Returns all properties pertaining to this resource.
 o getName()
Returns the name of this resource.
 o getPlace()
Returns the place containing this resource
 o getProperties()
Returns all properties pertaining to this resource.
 o getProperty(String)
Returns the Property object specified by the propName.
 o getSession()
Returns the session of this resource.
 o isActive()
Returns the active status.

Variables

 o OBTAINERS
 public static final String OBTAINERS
Obtainers property name. The property value is the name of the ACL whose members may obtain or view this resource. Default is the Place.READERS.

 o WRITERS
 public static final String WRITERS
Writers property name. The property value is the name of the ACL whose members may change this resource. Default is the Place.WRITERS.

 o DESTROYERS
 public static final String DESTROYERS
Destroyers property name. The property value is the name of the ACL whose members may destroy this resource. Default is the Resource.WRITERS.

 o COPYRIGHT
 public static final String COPYRIGHT

Methods

 o getName
 public abstract String getName() throws IOException, NotAvailableException, SametimeException
Returns the name of this resource.

Throws: IOException
if cannot communicate with the server
Throws: NotAvailableException
if the name is not available locally and either the resource is not active or not accessible from the server
Throws: PrivilegeException
if access not permitted
Throws: SametimeException
if internal error occurs
 o getProperty
 public abstract Property getProperty(String propName) throws IOException, NotAvailableException, SametimeException
Returns the Property object specified by the propName.

Parameters:
propName - the name of the property
Throws: IOException
if cannot communicate with the server
Throws: NotAvailableException
if the property is not available because either the resource is not active or not accessible
Throws: SametimeException
if internal error occurs
 o getProperties
 public abstract Property[] getProperties() throws IOException, NotAvailableException, SametimeException
Returns all properties pertaining to this resource.

Throws: IOException
if cannot communicate with the server
Throws: NotAvailableException
if the properties are not available because either the resource is not active or not accessible
Throws: SametimeException
if internal error occurs
 o getSession
 public abstract Session getSession()
Returns the session of this resource.

 o getPlace
 public abstract Place getPlace()
Returns the place containing this resource

 o getAccessControl
 public abstract SametimeAccessControl getAccessControl() throws IOException, NotAvailableException, SametimeException
Returns all properties pertaining to this resource.

Throws: IOException
if cannot communicate with the server
Throws: NotAvailableException
if the access control is not available because either the resource is not active or not accessible
Throws: SametimeException
if internal error occurs
 o destroy
 public abstract void destroy(String reason) throws IOException, IllegalStateException, PrivilegeException, SametimeException
Destroys the resource.

Parameters:
reason - reason to destroy
Throws: IOException
if cannot communicate with the server
Throws: IllegalStateException
if this ACL is not active
Throws: PrivilegeException
if access not permitted
Throws: SametimeException
if internal error occurs
 o isActive
 public abstract boolean isActive() throws IOException, PrivilegeException, SametimeException
Returns the active status.

Throws: IOException
if cannot communicate with the server
Throws: PrivilegeException
if access not permitted
Throws: SametimeException
if internal error occurs

All Packages  Class Hierarchy  This Package  Previous  Next  Index