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.
-
COPYRIGHT
-
-
DESTROYERS
- Destroyers property name.
-
OBTAINERS
- Obtainers property name.
-
WRITERS
- Writers property name.
-
destroy(String)
- Destroys the resource.
-
getAccessControl()
- Returns all properties pertaining to this resource.
-
getName()
- Returns the name of this resource.
-
getPlace()
- Returns the place containing this resource
-
getProperties()
- Returns all properties pertaining to this resource.
-
getProperty(String)
- Returns the Property object specified by the propName.
-
getSession()
- Returns the session of this resource.
-
isActive()
- Returns the active status.
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.
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.
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.
COPYRIGHT
public static final String COPYRIGHT
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
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
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
getSession
public abstract Session getSession()
- Returns the session of this resource.
getPlace
public abstract Place getPlace()
- Returns the place containing this resource
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
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
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