org.opensolaris.opengrok.management
Interface ManagementMBean

All Known Implementing Classes:
Management

public interface ManagementMBean


Method Summary
 java.lang.String getConfigurationFile()
          Get the xml based configuration file
 java.util.logging.Level getConsoleLogLevel()
          Get the current loglevel for the console
 java.util.logging.Level getFileLogLevel()
          get the loglevel on the agent logfile
 java.lang.String getFileLogPath()
          Get the file logpath
 java.lang.Integer getNumberOfThreads()
          Get number of Threads to use for indexing
 java.lang.String getProperty(java.lang.String key)
          Get a selected property from JAG configuration.
 java.lang.String getPublishServerURL()
          Get the URL to the Publish Server we want to publish the indexed data
 java.util.Date getStartDate()
          Get a Date object with the time the agent was started.
 long getStartTime()
          Get the time (in milliseconds since 1970) when the agent was started
 java.lang.String[] getSubFiles()
          Get subfiles
 java.lang.String getSystemEnvProperty(java.lang.String key)
          Get the selected Environment property
 java.lang.String getSystemProperty(java.lang.String key)
          Get the selected System property
 java.lang.Boolean getUpdateIndexDatabase()
          Get the udate database property
 java.lang.String getVersion()
          Get the version tag for the agent
 void setConfigurationFile(java.lang.String filename)
          Set a new name for the xml based configurationfile
 void setConsoleLogLevel(java.util.logging.Level level)
          Set the loglevel for the console
 void setFileLogLevel(java.util.logging.Level level)
          set the file log level
 void setFileLogPath(java.lang.String path)
          Set the path for the file logging
 void setNumberOfThreads(java.lang.Integer val)
          Set number of Threads to use for indexing
 void setProperty(java.lang.String key, java.lang.String value)
          Set a selected property in the JAG configuration.
 void setPublishServerURL(java.lang.String url)
          Set the URL to where to publish opengrok indexed data
 void setSubFiles(java.lang.String[] sublist)
          Set subfiles
 void setSystemProperty(java.lang.String key, java.lang.String value)
          Set a selected System property
 void setUpdateIndexDatabase(java.lang.Boolean val)
          Set update index database property
 void stop()
          Stops the agent, so it is not restarted.
 

Method Detail

stop

void stop()
Stops the agent, so it is not restarted.


getConfigurationFile

java.lang.String getConfigurationFile()
Get the xml based configuration file

Returns:
String with the file path and name for xml configuration

setConfigurationFile

void setConfigurationFile(java.lang.String filename)
Set a new name for the xml based configurationfile

Parameters:
filename - String name with full path of configurationfile

getPublishServerURL

java.lang.String getPublishServerURL()
Get the URL to the Publish Server we want to publish the indexed data

Returns:
String URL to the server (hostname:port)

setPublishServerURL

void setPublishServerURL(java.lang.String url)
Set the URL to where to publish opengrok indexed data

Parameters:
url - String to server for publishing the opengrok.war file

setUpdateIndexDatabase

void setUpdateIndexDatabase(java.lang.Boolean val)
Set update index database property

Parameters:
val - Boolean true to also run update index database

getUpdateIndexDatabase

java.lang.Boolean getUpdateIndexDatabase()
Get the udate database property

Returns:
Boolean returns true if update index database is switched on

setNumberOfThreads

void setNumberOfThreads(java.lang.Integer val)
Set number of Threads to use for indexing


getNumberOfThreads

java.lang.Integer getNumberOfThreads()
Get number of Threads to use for indexing


setSubFiles

void setSubFiles(java.lang.String[] sublist)
Set subfiles

Parameters:
sublist -

getSubFiles

java.lang.String[] getSubFiles()
Get subfiles

Returns:
get StringArray of subfiles to run through

getProperty

java.lang.String getProperty(java.lang.String key)
Get a selected property from JAG configuration.

Returns:
String with property value

setProperty

void setProperty(java.lang.String key,
                 java.lang.String value)
Set a selected property in the JAG configuration. JAG will immediately save its configuration to file when a property is set.

Parameters:
key - the String key for the property to be set. $param value the String value for the property to be set.

getSystemProperty

java.lang.String getSystemProperty(java.lang.String key)
Get the selected System property

Returns:
String with property value

setSystemProperty

void setSystemProperty(java.lang.String key,
                       java.lang.String value)
Set a selected System property

Parameters:
key - the String key for the property to be set. $param value the String value for the property to be set.

getSystemEnvProperty

java.lang.String getSystemEnvProperty(java.lang.String key)
Get the selected Environment property

Returns:
String with Environment property value

getStartTime

long getStartTime()
Get the time (in milliseconds since 1970) when the agent was started

Returns:
long time when the agent was started, in milliseconds.

getStartDate

java.util.Date getStartDate()
Get a Date object with the time the agent was started.

Returns:
Date with the starting date

getVersion

java.lang.String getVersion()
Get the version tag for the agent

Returns:
String the version tag for this agent

setConsoleLogLevel

void setConsoleLogLevel(java.util.logging.Level level)
Set the loglevel for the console

Parameters:
level - the level for console logging

getConsoleLogLevel

java.util.logging.Level getConsoleLogLevel()
Get the current loglevel for the console

Returns:
Level current console loglevel

setFileLogLevel

void setFileLogLevel(java.util.logging.Level level)
set the file log level

Parameters:
level - the level for file logging

getFileLogLevel

java.util.logging.Level getFileLogLevel()
get the loglevel on the agent logfile

Returns:
Level for file logging

setFileLogPath

void setFileLogPath(java.lang.String path)
                    throws java.io.IOException
Set the path for the file logging

Parameters:
path - String path to where to log
Throws:
java.io.IOException - if path does not exist or could be created on server

getFileLogPath

java.lang.String getFileLogPath()
Get the file logpath

Returns:
String file log path