com.filenet.api.admin
Interface Site

All Superinterfaces:
EngineObject, IndependentlyPersistableObject, IndependentObject, java.io.Serializable

public interface Site
extends IndependentlyPersistableObject

Identifies a geographical area within a FileNet P8 domain. A domain can have one or more configured sites. Each site is identified by a unique name and has associated servers and resources (such as object stores, index areas, storage areas, and content caches). Associated resource objects in the same geographical area have the same Site property.

When a Content Engine server in a geographically distributed environment processes a user request, it determines what resources it will need to process the request, and makes use of the site information in these resources to determine how best to process the request. The site information will determine whether or not content retrievals and uploads are processed through a content cache, and whether or not the request will be forwarded to a server in another site, closer to the resources required to process the request.

When the Content Engine server is initialized and the GCD created, a factory-generated instance of the Site class, called "Initial Site," is created and referenced by the Domain.DefaultSite property. As Virtual Servers, Server Instances, and resources (object stores, storage areas, etc.) are added to the domain, they are assigned to the DefaultSite, unless a different site is explicitly specified. A user with system administrator privileges can change the Domain.DefaultSite to a different default site, if desired.

For more information about request forwarding, see "Request Forwarding Concepts" in the Content Engine Administration documentation.

To create a new instance of this class, call Factory.Site.createInstance.

Metadata

Auditable: false
AllowsInstances: true
AllowsSubClasses: false
ClassDefinitionName: None
IsDependent: false
IsHidden: false
Searchable: false
StorageType: Domain
SuperclassName: GenericObject


Method Summary
 java.lang.String get_ActiveDirectorySiteDNS()
          Returns the value of the ActiveDirectorySiteDNS property.
 java.lang.Boolean get_CanAcceptForwardedRequests()
          Returns the value of the CanAcceptForwardedRequests property.
 java.lang.Boolean get_CanForwardRequests()
          Returns the value of the CanForwardRequests property.
 java.lang.String get_Creator()
          Returns the value of the Creator property.
 java.util.Date get_DateCreated()
          Returns the value of the DateCreated property.
 java.util.Date get_DateLastModified()
          Returns the value of the DateLastModified property.
 java.lang.String get_DescriptiveText()
          Returns the value of the DescriptiveText property.
 java.lang.String get_DisplayName()
          Returns the value of the DisplayName property.
 Id get_Id()
          Returns the value of the Id property.
 java.lang.String get_LastModifier()
          Returns the value of the LastModifier property.
 java.lang.String get_Name()
          Returns the value of the Name property.
 SubsystemConfigurationList get_SubsystemConfigurations()
          Returns the value of the SubsystemConfigurations property.
 VirtualServerSet get_VirtualServers()
          Returns the value of the VirtualServers property.
 void set_ActiveDirectorySiteDNS(java.lang.String value)
          Sets the value of the ActiveDirectorySiteDNS property.
 void set_CanAcceptForwardedRequests(java.lang.Boolean value)
          Sets the value of the CanAcceptForwardedRequests property.
 void set_CanForwardRequests(java.lang.Boolean value)
          Sets the value of the CanForwardRequests property.
 void set_Creator(java.lang.String value)
          Sets the value of the Creator property.
 void set_DateCreated(java.util.Date value)
          Sets the value of the DateCreated property.
 void set_DateLastModified(java.util.Date value)
          Sets the value of the DateLastModified property.
 void set_DescriptiveText(java.lang.String value)
          Sets the value of the DescriptiveText property.
 void set_DisplayName(java.lang.String value)
          Sets the value of the DisplayName property.
 void set_LastModifier(java.lang.String value)
          Sets the value of the LastModifier property.
 void set_SubsystemConfigurations(SubsystemConfigurationList value)
          Sets the value of the SubsystemConfigurations property.
 
Methods inherited from interface com.filenet.api.core.IndependentlyPersistableObject
addPendingAction, clearPendingActions, delete, getAccessAllowed, getPendingActions, getUpdateSequenceNumber, isCurrent, save, save, setUpdateSequenceNumber
 
Methods inherited from interface com.filenet.api.core.IndependentObject
fetchProperties, fetchProperties, fetchProperty, fetchProperty, getObjectReference, refresh, refresh, refresh
 
Methods inherited from interface com.filenet.api.core.EngineObject
get_ClassDescription, getClassName, getConnection, getProperties, getSuperClasses
 

Method Detail

get_Creator

java.lang.String get_Creator()
Returns the value of the Creator property. For more information, see Creator Property.


set_Creator

void set_Creator(java.lang.String value)
Sets the value of the Creator property. For more information, see Creator Property.


get_DateCreated

java.util.Date get_DateCreated()
Returns the value of the DateCreated property. For more information, see DateCreated Property.


set_DateCreated

void set_DateCreated(java.util.Date value)
Sets the value of the DateCreated property. For more information, see DateCreated Property.


get_LastModifier

java.lang.String get_LastModifier()
Returns the value of the LastModifier property. For more information, see LastModifier Property.


set_LastModifier

void set_LastModifier(java.lang.String value)
Sets the value of the LastModifier property. For more information, see LastModifier Property.


get_DateLastModified

java.util.Date get_DateLastModified()
Returns the value of the DateLastModified property. For more information, see DateLastModified Property.


set_DateLastModified

void set_DateLastModified(java.util.Date value)
Sets the value of the DateLastModified property. For more information, see DateLastModified Property.


get_Id

Id get_Id()
Returns the value of the Id property. For more information, see Id Property.


get_Name

java.lang.String get_Name()
Returns the value of the Name property. For more information, see Name Property.


get_DisplayName

java.lang.String get_DisplayName()
Returns the value of the DisplayName property. For more information, see DisplayName Property.


set_DisplayName

void set_DisplayName(java.lang.String value)
Sets the value of the DisplayName property. For more information, see DisplayName Property.


get_DescriptiveText

java.lang.String get_DescriptiveText()
Returns the value of the DescriptiveText property. For more information, see DescriptiveText Property.


set_DescriptiveText

void set_DescriptiveText(java.lang.String value)
Sets the value of the DescriptiveText property. For more information, see DescriptiveText Property.


get_VirtualServers

VirtualServerSet get_VirtualServers()
Returns the value of the VirtualServers property. For more information, see VirtualServers Property.


get_SubsystemConfigurations

SubsystemConfigurationList get_SubsystemConfigurations()
Returns the value of the SubsystemConfigurations property. For more information, see SubsystemConfigurations Property.


set_SubsystemConfigurations

void set_SubsystemConfigurations(SubsystemConfigurationList value)
Sets the value of the SubsystemConfigurations property. For more information, see SubsystemConfigurations Property.


get_CanAcceptForwardedRequests

java.lang.Boolean get_CanAcceptForwardedRequests()
Returns the value of the CanAcceptForwardedRequests property. For more information, see CanAcceptForwardedRequests Property.


set_CanAcceptForwardedRequests

void set_CanAcceptForwardedRequests(java.lang.Boolean value)
Sets the value of the CanAcceptForwardedRequests property. For more information, see CanAcceptForwardedRequests Property.


get_CanForwardRequests

java.lang.Boolean get_CanForwardRequests()
Returns the value of the CanForwardRequests property. For more information, see CanForwardRequests Property.


set_CanForwardRequests

void set_CanForwardRequests(java.lang.Boolean value)
Sets the value of the CanForwardRequests property. For more information, see CanForwardRequests Property.


get_ActiveDirectorySiteDNS

java.lang.String get_ActiveDirectorySiteDNS()
Returns the value of the ActiveDirectorySiteDNS property. For more information, see ActiveDirectorySiteDNS Property.


set_ActiveDirectorySiteDNS

void set_ActiveDirectorySiteDNS(java.lang.String value)
Sets the value of the ActiveDirectorySiteDNS property. For more information, see ActiveDirectorySiteDNS Property.



© Copyright IBM Corporation 2006, 2008. All rights reserved.