com.esri.aims.mtier.model.admin
Class Site

java.lang.Object
  extended by com.esri.aims.mtier.model.admin.Site

public class Site
extends Object

Represents the access point to a site (at 4.0, this is a single Application Server) and all operations on that site.


Field Summary
static int SITE_CONTAINS_AIMS
           
static int SITE_CONTAINS_ALL
           
static int SITE_CONTAINS_NONE
           
static int SITE_CONTAINS_SDE
           
 
Constructor Summary
Site()
          Constructs a new Site object.
 
Method Summary
 int getAdminInfo(ConnectionProxy connection)
          Returns information about the type of site this is: ArcIMS, ArcSDE, both, or neither; this is done through static constants defined in this class (SITE_CONTAINS_*).
 Properties getSiteProperties(ConnectionProxy connection)
          Returns all site properties.
 Properties getSiteProperty(String propertyName, ConnectionProxy connection)
          Returns a site property with the given name string.
 Properties getStartupProperties(ConnectionProxy connection)
          Returns all site startup properties from the AppServer.
 boolean removeSiteProperty(String propertyName, ConnectionProxy connection)
          Removes a site property with given name string.
 boolean save(ConnectionProxy connection)
          Saves the site configuration.
 boolean setSiteProperty(String propertyName, String propertyValue, ConnectionProxy connection)
          Sets a site property with the given name and value.
 boolean setSiteUser(String newUsername, String newPassword, ConnectionProxy connection)
          Sets the username and password for this Site.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

SITE_CONTAINS_NONE

public static final int SITE_CONTAINS_NONE
See Also:
Constant Field Values

SITE_CONTAINS_AIMS

public static final int SITE_CONTAINS_AIMS
See Also:
Constant Field Values

SITE_CONTAINS_SDE

public static final int SITE_CONTAINS_SDE
See Also:
Constant Field Values

SITE_CONTAINS_ALL

public static final int SITE_CONTAINS_ALL
See Also:
Constant Field Values
Constructor Detail

Site

public Site()
Constructs a new Site object.

Method Detail

save

public boolean save(ConnectionProxy connection)
             throws ConnectionParameterException,
                    AuthenticationException,
                    com.esri.aims.mtier.io.http.UnableToPingEsrimapException,
                    ParserConfigurationException,
                    com.esri.aims.mtier.model.axl.ErrorAndWarningException,
                    SAXException
Saves the site configuration.

Returns:
a boolean variable - True, if successful, False otherwise.
Throws:
ConnectionParameterException, - when the parameters used to initialize a MetadataConnectionProxy contain errors.
AuthenticationException, - when the ConnectionProxy cannot validate the user and/or the password supplied.
UnableToPingEsrimapException, - when trying to construct a BaseEsrimap and the code is unable to ping the ESRIMAP.
ErrorAndWarningException, - when an ERROR or WARNING response is received.
ConnectionParameterException
AuthenticationException
com.esri.aims.mtier.io.http.UnableToPingEsrimapException
ParserConfigurationException
com.esri.aims.mtier.model.axl.ErrorAndWarningException
SAXException

setSiteProperty

public boolean setSiteProperty(String propertyName,
                               String propertyValue,
                               ConnectionProxy connection)
                        throws ConnectionParameterException,
                               AuthenticationException,
                               com.esri.aims.mtier.io.http.UnableToPingEsrimapException,
                               ParserConfigurationException,
                               com.esri.aims.mtier.model.axl.ErrorAndWarningException,
                               SAXException,
                               com.esri.aims.mtier.model.axl.AXLAttributeException
Sets a site property with the given name and value.

Returns:
a boolean variable - True, if successful, False otherwise.
Throws:
ConnectionParameterException, - when the parameters used to initialize a MetadataConnectionProxy contain errors.
AuthenticationException, - when the ConnectionProxy cannot validate the user and/or the password supplied.
UnableToPingEsrimapException, - when trying to construct a BaseEsrimap and the code is unable to ping the ESRIMAP.
ErrorAndWarningException, - when an ERROR or WARNING response is received.
ConnectionParameterException
AuthenticationException
com.esri.aims.mtier.io.http.UnableToPingEsrimapException
ParserConfigurationException
com.esri.aims.mtier.model.axl.ErrorAndWarningException
SAXException
com.esri.aims.mtier.model.axl.AXLAttributeException

getSiteProperty

public Properties getSiteProperty(String propertyName,
                                  ConnectionProxy connection)
                           throws ConnectionParameterException,
                                  AuthenticationException,
                                  com.esri.aims.mtier.io.http.UnableToPingEsrimapException,
                                  ParserConfigurationException,
                                  com.esri.aims.mtier.model.axl.ErrorAndWarningException,
                                  SAXException,
                                  com.esri.aims.mtier.model.axl.AXLAttributeException
Returns a site property with the given name string.

Returns:
a boolean variable - True, if successful, False otherwise.
Throws:
ConnectionParameterException, - when the parameters used to initialize a MetadataConnectionProxy contain errors.
AuthenticationException, - when the ConnectionProxy cannot validate the user and/or the password supplied.
UnableToPingEsrimapException, - when trying to construct a BaseEsrimap and the code is unable to ping the ESRIMAP.
ErrorAndWarningException, - when an ERROR or WARNING response is received.
ConnectionParameterException
AuthenticationException
com.esri.aims.mtier.io.http.UnableToPingEsrimapException
ParserConfigurationException
com.esri.aims.mtier.model.axl.ErrorAndWarningException
SAXException
com.esri.aims.mtier.model.axl.AXLAttributeException

getSiteProperties

public Properties getSiteProperties(ConnectionProxy connection)
                             throws ConnectionParameterException,
                                    AuthenticationException,
                                    com.esri.aims.mtier.io.http.UnableToPingEsrimapException,
                                    ParserConfigurationException,
                                    com.esri.aims.mtier.model.axl.ErrorAndWarningException,
                                    SAXException,
                                    com.esri.aims.mtier.model.axl.AXLAttributeException
Returns all site properties.

Returns:
a Properties object.
Throws:
ConnectionParameterException, - when the parameters used to initialize a MetadataConnectionProxy contain errors.
AuthenticationException, - when the ConnectionProxy cannot validate the user and/or the password supplied.
UnableToPingEsrimapException, - when trying to construct a BaseEsrimap and the code is unable to ping the ESRIMAP.
ErrorAndWarningException, - when an ERROR or WARNING response is received.
ConnectionParameterException
AuthenticationException
com.esri.aims.mtier.io.http.UnableToPingEsrimapException
ParserConfigurationException
com.esri.aims.mtier.model.axl.ErrorAndWarningException
SAXException
com.esri.aims.mtier.model.axl.AXLAttributeException

removeSiteProperty

public boolean removeSiteProperty(String propertyName,
                                  ConnectionProxy connection)
                           throws ConnectionParameterException,
                                  AuthenticationException,
                                  com.esri.aims.mtier.io.http.UnableToPingEsrimapException,
                                  ParserConfigurationException,
                                  com.esri.aims.mtier.model.axl.ErrorAndWarningException,
                                  SAXException,
                                  com.esri.aims.mtier.model.axl.AXLAttributeException
Removes a site property with given name string.

Returns:
a boolean variable - True, if successful, False otherwise.
Throws:
ConnectionParameterException, - when the parameters used to initialize a MetadataConnectionProxy contain errors.
AuthenticationException, - when the ConnectionProxy cannot validate the user and/or the password supplied.
UnableToPingEsrimapException, - when trying to construct a BaseEsrimap and the code is unable to ping the ESRIMAP.
ErrorAndWarningException, - when an ERROR or WARNING response is received.
AXLAttributeException, - when an error occurs during reading or writing an AXL attribute.
ConnectionParameterException
AuthenticationException
com.esri.aims.mtier.io.http.UnableToPingEsrimapException
ParserConfigurationException
com.esri.aims.mtier.model.axl.ErrorAndWarningException
SAXException
com.esri.aims.mtier.model.axl.AXLAttributeException

setSiteUser

public boolean setSiteUser(String newUsername,
                           String newPassword,
                           ConnectionProxy connection)
                    throws ConnectionParameterException,
                           AuthenticationException,
                           com.esri.aims.mtier.io.http.UnableToPingEsrimapException,
                           com.esri.aims.mtier.model.axl.AXLAttributeException,
                           ParserConfigurationException,
                           com.esri.aims.mtier.model.axl.ErrorAndWarningException,
                           SAXException
Sets the username and password for this Site. When this is done, the username and passoword for the given ConnectionProxy is changed to reflect the update.

Returns:
a boolean variable - True, if successful, False otherwise.
Throws:
ConnectionParameterException, - when the parameters used to initialize a MetadataConnectionProxy contain errors.
AuthenticationException, - when the ConnectionProxy cannot validate the user and/or the password supplied.
UnableToPingEsrimapException, - when trying to construct a BaseEsrimap and the code is unable to ping the ESRIMAP.
ErrorAndWarningException, - when an ERROR or WARNING response is received.
AXLAttributeException, - when an error occurs during reading or writing an AXL attribute.
ConnectionParameterException
AuthenticationException
com.esri.aims.mtier.io.http.UnableToPingEsrimapException
com.esri.aims.mtier.model.axl.AXLAttributeException
ParserConfigurationException
com.esri.aims.mtier.model.axl.ErrorAndWarningException
SAXException

getAdminInfo

public int getAdminInfo(ConnectionProxy connection)
                 throws ConnectionParameterException,
                        AuthenticationException,
                        com.esri.aims.mtier.io.http.UnableToPingEsrimapException,
                        com.esri.aims.mtier.model.axl.AXLAttributeException,
                        ParserConfigurationException,
                        com.esri.aims.mtier.model.axl.ErrorAndWarningException,
                        SAXException,
                        IOException
Returns information about the type of site this is: ArcIMS, ArcSDE, both, or neither; this is done through static constants defined in this class (SITE_CONTAINS_*).

Returns:
int A static contstant defined in this class.
Throws:
ConnectionParameterException, - when the parameters used to initialize a MetadataConnectionProxy contain errors.
AuthenticationException, - when the ConnectionProxy cannot validate the user and/or the password supplied.
UnableToPingEsrimapException, - when trying to construct a BaseEsrimap and the code is unable to ping the ESRIMAP.
ErrorAndWarningException, - when an ERROR or WARNING response is received.
AXLAttributeException, - when an error occurs during reading or writing an AXL attribute.
IOException - if an I/O error occurs.
ConnectionParameterException
AuthenticationException
com.esri.aims.mtier.io.http.UnableToPingEsrimapException
com.esri.aims.mtier.model.axl.AXLAttributeException
ParserConfigurationException
com.esri.aims.mtier.model.axl.ErrorAndWarningException
SAXException

getStartupProperties

public Properties getStartupProperties(ConnectionProxy connection)
                                throws ConnectionParameterException,
                                       AuthenticationException,
                                       com.esri.aims.mtier.io.http.UnableToPingEsrimapException,
                                       ParserConfigurationException,
                                       com.esri.aims.mtier.model.axl.ErrorAndWarningException,
                                       SAXException,
                                       com.esri.aims.mtier.model.axl.AXLAttributeException
Returns all site startup properties from the AppServer.

Returns:
a Properties object.
Throws:
ConnectionParameterException, - when the parameters used to initialize a MetadataConnectionProxy contain errors.
AuthenticationException, - when the ConnectionProxy cannot validate the user and/or the password supplied.
UnableToPingEsrimapException, - when trying to construct a BaseEsrimap and the code is unable to ping the ESRIMAP.
ErrorAndWarningException, - when an ERROR or WARNING response is received.
ConnectionParameterException
AuthenticationException
com.esri.aims.mtier.io.http.UnableToPingEsrimapException
ParserConfigurationException
com.esri.aims.mtier.model.axl.ErrorAndWarningException
SAXException
com.esri.aims.mtier.model.axl.AXLAttributeException