*** This API provides Binary Compatibility only, not Source Compatibility ***

com.sas.services.information.metadata
Interface ServerInterface

All Superinterfaces:

MetadataInterface,

All Known Subinterfaces:

FtpServerInterface, HttpServerInterface, LogicalServerInterface, ServerComponentInterface, ServerContextInterface

All Known Implementing Classes:

LdapServer, OMRServer,

public interface ServerInterface

extends MetadataInterface

This is a generic interface for interacting with a repository entry that represents a server of some sort.

Since:

1.0

Fields inherited from interface com.sas.services.information.metadata.MetadataInterface

PERMISSION_READMETADATA, PERMISSION_WRITEMETADATA

Method Summary

void	addProperty(PropertyInterface property) Add a property to the set of properties for this server.
void	addServed(ServerInterface server) Add a new server to the list of servers that use this server.
void	addServer(ServerInterface server) Add a new server to the list of servers that this server uses.
String	getApplicationProtocol() Get the application protocol string for the server.
String	getClassIdentifier() Get the class identifier string for the server.
List	getConnectionProperties() Get the properties from the (first) connection.
List	getDataPackages() Get a list of the data packages (files) that exist on the server.
List	getDomains() Get a list of the authentication domains that the server is running in.
String	getHost() Get the DNS name for the host the server is running on.
List	getProperties() Get a List of the properties associated with this server.
List	getProperties(String name) Get all properties matching a name.
PropertyInterface	getProperty(String name) Get a named property for this server.
List	getServed() Get a list of components that are served by this server.
List	getServers() Get a list of servers that this server uses.
List	getServiceTypes() Get a list of the service types for this server.
int	getTcpPort() Get the port number the server is listening on.
void	removeProperty(PropertyInterface property) Remove a property from the server.
void	removeServed(ServerInterface server) Remove a server from the list that's served by this server.
void	removeServer(ServerInterface server) Remove a server from the list used by this server.
void	setApplicationProtocol(String protocol) Set the application protocol string for the server.
void	setHost(String host) Set the DNS name of the host where the server is running.
void	setTcpPort(int port) Set the port number the server is listening on.

Methods inherited from interface com.sas.services.information.metadata.MetadataInterface

add, addAccessControl, addAttribute, addAttributes, addExtension, addKeyword, addPermissions, addRemark, addTransactionListener, checkin, checkout, commit, copyTo, delete, deleteAttribute, deleteAttributes, getAccessControls, getAttribute, getAttributes, getCreateDate, getDescription, getEntityKey, getEntityURL, getExtensions, getGUID, getIdentities, getKeywords, getModifyDate, getName, getParentPath, getParents, getPath, getPaths, getPathUrl, getPathUrl, getPermission, getPermissions, getPermissions, getPreviousVersionNames, getRemarksList, getReposId, getRepository, getRepositoryEntity, getReposKey, getTrackingId, getType, getVersion, isAuthorized, isLoggingEnabled, logMessage, mapNameToFilesystem, mapUrlToFilesystem, moveTo, newServiceObject, refresh, removeAccessControl, removeExtension, removeKeyword, removePermissions, rollback, setAttribute, setAttributes, setDescription, setGUID, setKeywords, setName, setPermission, setRemarksList, setRepository, startTransaction, transactionEvent, uncheckout, update, version

Method Detail

getHost

public String getHost()
               throws RemoteException

Get the DNS name for the host the server is running on.

Returns:

The host name.

Throws:

RemoteException - in the event of remote object failure.

setHost

public void setHost(String host)
             throws RemoteException

Set the DNS name of the host where the server is running.

Parameters:

host - The host name.

Throws:

RemoteException - in the event of remote object failure.

getTcpPort

public int getTcpPort()
               throws RemoteException

Get the port number the server is listening on.

Returns:

The port number;

Throws:

RemoteException - in the event of remote object failure.

setTcpPort

public void setTcpPort(int port)
                throws RemoteException

Set the port number the server is listening on.

Parameters:

port - The port number;

Throws:

RemoteException - in the event of remote object failure.

getDomains

public List getDomains()
                throws RemoteException

Get a list of the authentication domains that the server is running in.

Returns:

a List of Strings with the names of the authentication domains the server is running in.

Throws:

RemoteException - in the event of remote object failure.

getApplicationProtocol

public String getApplicationProtocol()
                              throws RemoteException

Get the application protocol string for the server.

Returns:

The application protocol string.

Throws:

RemoteException - in the event of remote object failure.

setApplicationProtocol

public void setApplicationProtocol(String protocol)
                            throws RemoteException

Set the application protocol string for the server.

Parameters:

protocol - The new application protocol string.

Throws:

RemoteException - in the event of remote object failure.

getClassIdentifier

public String getClassIdentifier()
                          throws RemoteException

Get the class identifier string for the server.

Returns:

The application protocol string.

Throws:

RemoteException - in the event of remote object failure.

getProperties

public List getProperties()
                   throws ServiceException,
                          RemoteException

Get a List of the properties associated with this server.

Returns:

A List of PropertyInterface objects

Throws:

ServiceException - in the event of service object failure.

RemoteException - in the event of remote object failure.

getProperty

public PropertyInterface getProperty(String name)
                              throws ServiceException,
                                     RemoteException

Get a named property for this server. It's possible for more than one property to exist for a given name. This method will only return the first instance it finds for that name.

Parameters:

name - The name of the property to retrieve.

Returns:

a PropertyInterface object, or null if no property matching the name exists.

Throws:

ServiceException - in the event of service object failure.

RemoteException - in the event of remote object failure.

getProperties

public List getProperties(String name)
                   throws ServiceException,
                          RemoteException

Get all properties matching a name.

Parameters:

name - The name to search for.

Returns:

a List of PropertyInterface objects. If there are no properties matching the name, an empty list is returned.

Throws:

ServiceException - in the event of service object failure.

RemoteException - in the event of remote object failure.

addProperty

public void addProperty(PropertyInterface property)
                 throws ServiceException,
                        RemoteException

Add a property to the set of properties for this server.

Parameters:

property - A new Property object to add to this server's properties.

Throws:

ServiceException - in the event of service object failure.

RemoteException - in the event of remote object failure.

removeProperty

public void removeProperty(PropertyInterface property)
                    throws ServiceException,
                           RemoteException

Remove a property from the server.

Parameters:

property - property to remove

Throws:

ServiceException - in the event of Service object failure.

RemoteException - in the event of remote object failure.

getServers

public List getServers()
                throws ServiceException,
                       RemoteException

Get a list of servers that this server uses. This is particularly useful for the LogicalServer subclass.

Returns:

a List of Server objects.

Throws:

ServiceException - in the event of service object failure.

RemoteException - in the event of remote object failure.

addServer

public void addServer(ServerInterface server)
               throws ServiceException,
                      RemoteException

Add a new server to the list of servers that this server uses.

Parameters:

server - A new Server to add to the list used by this one.

Throws:

ServiceException - in the event of service object failure.

RemoteException - in the event of remote object failure.

removeServer

public void removeServer(ServerInterface server)
                  throws ServiceException,
                         RemoteException

Remove a server from the list used by this server.

Parameters:

server - Server to remove from the list for this server.

Throws:

ServiceException - In the event of service object failure.

RemoteException - in the event of remote object failure.

getServed

public List getServed()
               throws ServiceException,
                      RemoteException

Get a list of components that are served by this server.

Returns:

A list of servers that use this server.

Throws:

ServiceException - in the event of service object failure.

RemoteException - in the event of remote object failure.

addServed

public void addServed(ServerInterface server)
               throws ServiceException,
                      RemoteException

Add a new server to the list of servers that use this server.

Parameters:

server - a new server to add to the list that use this server.

Throws:

ServiceException - in the event of service object failure.

RemoteException - in the event of remote object failure.

removeServed

public void removeServed(ServerInterface server)
                  throws ServiceException,
                         RemoteException

Remove a server from the list that's served by this server.

Parameters:

server - The server to remove from the served by list.

Throws:

ServiceException - in the event of service object failure.

RemoteException - in the event of remote object failure.

getServiceTypes

public List getServiceTypes()
                     throws ServiceException,
                            RemoteException

Get a list of the service types for this server. Service types are strings that describe the services that the server provides.

Returns:

a List of Strings representing the Service Types for the server.

Throws:

ServiceException - in the event of repository failure.

RemoteException - in the event of remote object failure.

getDataPackages

public List getDataPackages()
                     throws ServiceException,
                            RemoteException

Get a list of the data packages (files) that exist on the server.

Returns:

a List of DataPackage objects.

Throws:

ServiceException - in the event of repository failure.

RemoteException - in the event of remote object failure.

getConnectionProperties

public List getConnectionProperties()
                             throws ServiceException,
                                    RemoteException

Get the properties from the (first) connection.

Returns:

a List of Property objects from the first connection we find, if there are more than one.

Throws:

ServiceException - in the event of repository error.

RemoteException - in the event of remote object failure.

*** This API provides Binary Compatibility only, not Source Compatibility ***