Represents a logical entity for managing a group of server instances. Multiple server instances can run simultaneously on a single physical machine, or can be deployed on separate machines. A virtual server is composed of multiple server instances logically operating together to provide a service or services. Clients of the Content Engine interact with a VirtualServer, rather than interacting with a specific ServerInstance. If a VirtualServer consists of a single ServerInstance, then the two are functionally equivalent. If a VirtualServer consists of multiple server instances, then client requests are distributed between each individual ServerInstance, providing scalability and high availability. Clients are not aware of which ServerInstance actually fulfilled their request.

When multiple server instances are configured to run as a VirtualServer, a third-party (non-FileNet) load balancing mechanism must exist to distribute incoming requests to the server instances. This may be a Java 2 Platform Enterprise Edition (J2EE) application server's clustering implementation, or it could be an external hardware or software load balancing product. In either case, an administrator, using the third-party's load balancing configuration tools, is responsible for configuring the load balancing for a VirtualServer.

VirtualServer objects are created dynamically during system initialization and startup based on the configured topology of the application server or via specific system properties. They cannot be created via the API. You can retrieve a persisted VirtualServer object by calling GetInstance or FetchInstance on the Factory.VirtualServer class.


Namespace: FileNet.Api.Admin
Assembly: FileNet.Api (in filenet.api.dll)

Syntax

Visual Basic (Declaration)
Public Interface IVirtualServer
    Implements IIndependentlyPersistableObject, IIndependentObject, IEngineObject, ICloneable
C#
public interface IVirtualServer : IIndependentlyPersistableObject, IIndependentObject, IEngineObject, ICloneable
C++
interface class IVirtualServer : IIndependentlyPersistableObject, IIndependentObject, IEngineObject, ICloneable
J#
public interface IVirtualServer implements IIndependentlyPersistableObject, IIndependentObject, IEngineObject, ICloneable
JScript
public interface IVirtualServer extends IIndependentlyPersistableObject, IIndependentObject, IEngineObject, ICloneable

Remarks

Metadata

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

See Also