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

com.sas.services.information.metadata
Class LdapServer

java.lang.Object
  |
  +--java.rmi.server.RemoteObject
        |
        +--java.rmi.server.RemoteServer
              |
              +--java.rmi.server.UnicastRemoteObject
                    |
                    +--com.sas.services.information.metadata.Metadata
                          |
                          +--com.sas.services.information.metadata.Folder
                                |
                                +--com.sas.services.information.metadata.LdapServer

All Implemented Interfaces:

FolderInterface, MetadataInterface, ServerInterface

public class LdapServer

extends Folder

implements ServerInterface, java.io.Serializable

LDAP repository representation of a server.

Since:

1.0

See Also:

Serialized Form

Fields inherited from class com.sas.services.information.metadata.Metadata

_repository, _repositoryFlag, _repositoryObject, formats, gmtZone, REPOSITORY_DAV, REPOSITORY_LDAP, REPOSITORY_NONE, REPOSITORY_OMR

Fields inherited from class java.rmi.server.RemoteObject

ref

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

PERMISSION_READMETADATA, PERMISSION_WRITEMETADATA

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

FOLDER_TYPE_BIP

Constructor Summary

LdapServer()

LdapServer(RepositoryInterface repos, String name, FolderInterface parent)

LdapServer(Sasserver o)

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.
String	getName() Get the name for this object.
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.
String	getType() Get the object type.
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 class com.sas.services.information.metadata.Folder

addItem, addNewItem, addSubfolder, delete, deleteItem, deleteSubfolder, getFolderRefresh, getFolderType, getItem, getItemByClass, getItemByType, getItemRefresh, getItems, getItemsByClass, getItemsByType, getParent, getPath, getSubfolder, getSubfolders, makeSubfolder, mapNameToFilesystem, mapUrlToFilesystem, removeItem, removeSubfolder, setFolderRefresh, setFolderType, setItemRefresh, setName, setRepository

Methods inherited from class com.sas.services.information.metadata.Metadata

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

Methods inherited from class java.rmi.server.UnicastRemoteObject

clone, exportObject, exportObject, exportObject, unexportObject

Methods inherited from class java.rmi.server.RemoteServer

getClientHost, getLog, setLog

Methods inherited from class java.rmi.server.RemoteObject

equals, getRef, hashCode, toString, toStub

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

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, getParentPath, getParents, getPath, getPaths, getPathUrl, getPathUrl, getPermission, getPermissions, getPermissions, getPreviousVersionNames, getRemarksList, getReposId, getRepository, getRepositoryEntity, getReposKey, getTrackingId, 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

Constructor Detail

LdapServer

public LdapServer()
           throws RemoteException

LdapServer

public LdapServer(Sasserver o)
           throws RemoteException

LdapServer

public LdapServer(RepositoryInterface repos,
                  String name,
                  FolderInterface parent)
           throws RemoteException

Method Detail

getName

public String getName()
               throws RemoteException

Description copied from interface: MetadataInterface

Get the name for this object.

Specified by:

getName in interface MetadataInterface

Overrides:

getName in class Metadata

Following copied from interface: com.sas.services.information.metadata.MetadataInterface

Returns:

The object name.

Throws:

RemoteException - if an error occurs

getType

public String getType()
               throws RemoteException

Description copied from interface: MetadataInterface

Get the object type. Subclasses of Metadata will return a repository-neutral type string. If no subclass exists, Metadata returns the repository-specific type.

Specified by:

getType in interface MetadataInterface

Overrides:

getType in class Folder

Following copied from interface: com.sas.services.information.metadata.MetadataInterface

Returns:

A type string for the object.

Throws:

RemoteException - if an error occurs

getHost

public String getHost()
               throws RemoteException

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

Specified by:

getHost in interface ServerInterface

Returns:

The host name.

setHost

public void setHost(String host)
             throws RemoteException

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

Specified by:

setHost in interface ServerInterface

Parameters:

host - The host name.

getTcpPort

public int getTcpPort()
               throws RemoteException

Get the port number the server is listening on.

Specified by:

getTcpPort in interface ServerInterface

Returns:

The port number, or -1 if none defined.

setTcpPort

public void setTcpPort(int port)
                throws RemoteException

Set the port number the server is listening on.

Specified by:

setTcpPort in interface ServerInterface

Parameters:

port - The port number;

getDomains

public List getDomains()
                throws RemoteException

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

Specified by:

getDomains in interface ServerInterface

Returns:

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

getApplicationProtocol

public String getApplicationProtocol()
                              throws RemoteException

Get the application protocol string for the server.

Specified by:

getApplicationProtocol in interface ServerInterface

Returns:

The application protocol string.

setApplicationProtocol

public void setApplicationProtocol(String protocol)
                            throws RemoteException

Set the application protocol string for the server.

Specified by:

setApplicationProtocol in interface ServerInterface

Parameters:

protocol - The new application protocol string.

getClassIdentifier

public String getClassIdentifier()

Description copied from interface: ServerInterface

Get the class identifier string for the server.

Specified by:

getClassIdentifier in interface ServerInterface

Following copied from interface: com.sas.services.information.metadata.ServerInterface

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.

Specified by:

getProperties in interface ServerInterface

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.

Specified by:

getProperty in interface ServerInterface

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.

Specified by:

getProperties in interface ServerInterface

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.

Specified by:

addProperty in interface ServerInterface

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.

Specified by:

removeProperty in interface ServerInterface

Parameters:

property - The 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.

Specified by:

getServers in interface ServerInterface

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.

Specified by:

addServer in interface ServerInterface

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.

Specified by:

removeServer in interface ServerInterface

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.

Specified by:

getServed in interface ServerInterface

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.

Specified by:

addServed in interface ServerInterface

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.

Specified by:

removeServed in interface ServerInterface

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()

Description copied from interface: ServerInterface

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

Specified by:

getServiceTypes in interface ServerInterface

Following copied from interface: com.sas.services.information.metadata.ServerInterface

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.

Specified by:

getDataPackages in interface ServerInterface

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.

Specified by:

getConnectionProperties in interface ServerInterface

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 ***