Oracle Content Management SDK: Interface ServerInterface

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Oracle Content Management SDK

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

oracle.ifs.management.domain
Interface ServerInterface

All Known Implementing Classes:: Server

public interface ServerInterface

ServerInterface is the interface for Server, a managed iFS application.

Field Summary

static int SERVERSTATUS_DISPOSED
          A Server that has been disposed.

static int SERVERSTATUS_RUNNING
          A Server that is running.

static int SERVERSTATUS_STARTING
          A Server that is starting.

static int SERVERSTATUS_STOPPED
          A Server that is stopped.

static int SERVERSTATUS_STOPPING
          A Server that is stopping.

static int SERVERSTATUS_SUSPENDED
          A Server that is suspended.

static int SERVERSTATUS_UNKNOWN
          A Server whose status is unknown.

Method Summary

void dispose()
          Disposes this Server.

java.lang.String getName()
          Gets the name of this Server.

int getPriority()
          Gets the priority of this Server.

AttributeValue[] getProperties()
          Gets the values for all dynamic properties for this Server.

AttributeValue getProperty(java.lang.String name)
          Gets the value of the specified dynamic property for this Server.

java.lang.String getServerType()
          Gets the type of this Server.

java.lang.String getServiceName()
          Gets the name of the default service for this Server.

int getStatus()
          Gets the status of this Server.

boolean isAgent()
          Gets whether this Server is an agent.

boolean isPropertyReadonly(java.lang.String name)
          Gets whether the specified dynamic property is readonly.

void restart()
          Requests this Server to restart.

void resume()
          Requests this Server to resume.

void setPriority(int priority)
          Sets the priority of this Server.

void setProperty(AttributeValue av)
          Sets the value of the specified dynamic property for this Server.

void start()
          Requests this Server to start.

void stop()
          Requests this Server to stop.

boolean supportsPriority()
          Gets whether this Server supports set/get priority.

boolean supportsSuspendResume()
          Gets whether this Server supports suspend/resume.

void suspend()
          Requests this Server to suspend.

Field Detail

SERVERSTATUS_UNKNOWN

public static final int SERVERSTATUS_UNKNOWN

A Server whose status is unknown.

SERVERSTATUS_STOPPED

public static final int SERVERSTATUS_STOPPED

A Server that is stopped.

SERVERSTATUS_RUNNING

public static final int SERVERSTATUS_RUNNING

A Server that is running.

SERVERSTATUS_STOPPING

public static final int SERVERSTATUS_STOPPING

A Server that is stopping.

SERVERSTATUS_STARTING

public static final int SERVERSTATUS_STARTING

A Server that is starting.

SERVERSTATUS_SUSPENDED

public static final int SERVERSTATUS_SUSPENDED

A Server that is suspended.

SERVERSTATUS_DISPOSED

public static final int SERVERSTATUS_DISPOSED

A Server that has been disposed.

Method Detail

getName

public java.lang.String getName()
                         throws IfsException

Gets the name of this Server.

Returns:: the name
Throws:: IfsException - (IFS-45160) if the operation fails

getServerType

public java.lang.String getServerType()
                               throws IfsException

Gets the type of this Server.

Server type is used by iFS administration tools to aggregate data from servers of the same type in administration user interfaces.

Returns:: the server type
Throws:: IfsException - (IFS-45177) if the operation fails

isAgent

public boolean isAgent()
                throws IfsException

Gets whether this Server is an agent.

This method is called by iFS administration tools to group together servers that are agents in administration user interfaces.

Returns:: whether an agent
Throws:: IfsException - (IFS-45178) if the operation fails

getStatus

public int getStatus()
              throws IfsException

Gets the status of this Server.

Returns:: the enumerated status
Throws:: IfsException - (IFS-45161) if the operation fails

supportsSuspendResume

public boolean supportsSuspendResume()
                              throws IfsException

Gets whether this Server supports suspend/resume.

If false, then suspend and resume will throw an exception.

Returns:: whether suspend/resume is supported
Throws:: IfsException - (IFS-45162) if the operation fails

supportsPriority

public boolean supportsPriority()
                         throws IfsException

Gets whether this Server supports set/get priority.

If false, then setPriority and getPriority will throw an exception.

Returns:: whether set/get priority is supported
Throws:: IfsException - (IFS-45163) if the operation fails

start

public void start()
           throws IfsException

Requests this Server to start.

Throws:: IfsException - (IFS-45164) if the operation fails

stop

public void stop()
          throws IfsException

Requests this Server to stop.

Throws:: IfsException - (IFS-45165) if the operation fails

restart

public void restart()
             throws IfsException

Requests this Server to restart.

Restart is equivalent to a stop followed by a start.

Throws:: IfsException - (IFS-45166) if the operation fails

suspend

public void suspend()
             throws IfsException

Requests this Server to suspend.

Throws:: IfsException - (IFS-45167) if the operation fails

resume

public void resume()
            throws IfsException

Requests this Server to resume.

Throws:: IfsException - (IFS-45168) if the operation fails

dispose

public void dispose()
             throws IfsException

Disposes this Server.

This deregisters the Server to unload it from the iFS node. The Server must already be stopped.

Throws:: IfsException - (IFS-45169) if the operation fails

getPriority

public int getPriority()
                throws IfsException

Gets the priority of this Server.

The priority must be between Thread.MIN_PRIORITY and Thread.MAX_PRIORITY, inclusive.

Returns:: the priority
Throws:: IfsException - (IFS-45170) if the operation fails

setPriority

public void setPriority(int priority)
                 throws IfsException

Sets the priority of this Server.