ScmSystem

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

scm.pub.gateway.scmsystem
Class ScmSystem

java.lang.Object
  scm.pub.gateway.scmsystem.ScmSystem

public class ScmSystem
extends java.lang.Object

ScmSystem

Method Summary
`java.lang.String`	`getDbPath(java.lang.String db)` Get the absolute path to a project database
`static ScmSystem`	`getInstance()` Get the ScmSystem object
`java.util.Vector`	`getProjectNames()` Get the names of the Projects defined in this system.
`User_d`	`getUserInfo(java.lang.String user)` Get information about a specific user on this project.
`java.util.Vector`	`getUsers()` Get a listing of all of the Users defined in the System.
`void`	`logMessage(java.lang.String message)` Add a log message to the SpectrumSCM server logs.
`void`	`sendEMail(java.lang.String to, java.lang.String subject, java.lang.String text)` Send an E-mail message to the supplied to address.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

public static ScmSystem getInstance()
                             throws SystemException

Get the ScmSystem object

Returns:: The ScmSystem object.
Throws:: SystemException

logMessage

public void logMessage(java.lang.String message)

Add a log message to the SpectrumSCM server logs.

Parameters:: message - The text message to add to the SpectrumSCM server logs.

getDbPath

public java.lang.String getDbPath(java.lang.String db)

Get the absolute path to a project database

Parameters:: db - The name of the database to get the path for.
Returns:: The absolute path to the database file. Can return null if the database is unknown.

getProjectNames

public java.util.Vector getProjectNames()
                                 throws SystemException

Get the names of the Projects defined in this system.

Returns:: A Vector of project names as Strings.
Throws:: SystemException

getUsers

public java.util.Vector getUsers()
                          throws SystemException

Get a listing of all of the Users defined in the System.

Returns:: A Vector of user names as Strings.
Throws:: SystemException

getUserInfo

public User_d getUserInfo(java.lang.String user)
                   throws InvalidUser,
                          SystemException

Get information about a specific user on this project.

Parameters:: user - The names of a particular user.
Returns:: A User_d object containing all of a users information except for information that is project specific, which includes the user roles on particular projects.
Throws:: InvalidUser - If the supplied user id does not exist.; SystemException - If an internal exception is caught.

sendEMail

public void sendEMail(java.lang.String to,
                      java.lang.String subject,
                      java.lang.String text)
               throws SystemException

Send an E-mail message to the supplied to address.

Parameters:: to - The address to send this mail to.; subject - The subject of the message; text - The text of the message to send.
Throws:: SystemException - If an internal exception is caught.