NotificationHandler

The Notification service provides a toolkit to contact people via email to trigger some actions.

class DIRAC.FrameworkSystem.Service.NotificationHandler.NotificationHandler(handlerInitDict, trid)

Bases: NotificationHandlerMixin, RequestHandler

__init__(handlerInitDict, trid)

Constructor

Parameters:
  • handlerInitDict (dictionary) – Information vars for the service

  • trid (object) – Transport to use

auth_ping = ['all']
auth_refreshConfiguration = ['CSAdministrator']
auth_whoami = ['all']
static export_echo(data)

This method is used for testing performance of the service

Parameters:

data (str) – data to be sent back to the caller

Returns:

S_OK, Value is the input data

export_ping()
static export_refreshConfiguration(fromMaster)

Force refreshing the configuration data

Parameters:

fromMaster (bool) – flag to refresh from the master configuration service

export_sendMail(address, subject, body, fromAddress)

Send an email with supplied body to the specified address using the Mail utility.

Parameters:
  • address (str) – recipient addresses

  • subject (str) – subject of letter

  • body (str) – body of letter

  • fromAddress (str) – sender address, if “”, will be used default from CS

Returns:

S_OK(str)/S_ERROR() – str is status message

export_whoami()

A simple whoami, returns all credential dictionary, except certificate chain object.

classmethod getCSOption(optionName, defaultValue=False)

Get an option from the CS section of the services

Returns:

Value for serviceSection/optionName in the CS being defaultValue the default

getRemoteAddress()

Get the address of the remote peer.

Returns:

Address of remote peer.

getRemoteCredentials()

Get the credentials of the remote peer.

Returns:

Credentials dictionary of remote peer.

initialize()

Initialize this instance of the handler (to be overwritten)

classmethod initializeHandler(serviceInfo)

Handler initialization

srv_disconnect(trid=None)
classmethod srv_disconnectClient(trid)
srv_getActionTuple()
classmethod srv_getCSOption(optionName, defaultValue=False)

Get an option from the CS section of the services

Returns:

Value for serviceSection/optionName in the CS being defaultValue the default

srv_getClientSetup()
srv_getClientVO()
srv_getClientVersion()
srv_getFormattedRemoteCredentials()
classmethod srv_getMonitor()
srv_getRemoteAddress()

Get the address of the remote peer.

Returns:

Address of remote peer.

srv_getRemoteCredentials()

Get the credentials of the remote peer.

Returns:

Credentials dictionary of remote peer.

classmethod srv_getServiceName()
srv_getTransportID()
classmethod srv_getURL()
classmethod srv_msgCreate(msgName)
srv_msgReply(msgObj)
classmethod srv_msgSend(trid, msgObj)
transfer_bulkFromClient(bulkId, token, bulkSize, fileHelper)
transfer_bulkToClient(bulkId, token, fileHelper)
transfer_fromClient(fileId, token, fileSize, fileHelper)
transfer_listBulk(bulkId, token, fileHelper)
transfer_toClient(fileId, token, fileHelper)
types_echo = [<class 'str'>]
types_ping = []
types_refreshConfiguration = [<class 'bool'>]
types_sendMail = [<class 'str'>, <class 'str'>, <class 'str'>, <class 'str'>]
types_whoami = []
class DIRAC.FrameworkSystem.Service.NotificationHandler.NotificationHandlerMixin

Bases: object

export_sendMail(address, subject, body, fromAddress)

Send an email with supplied body to the specified address using the Mail utility.

Parameters:
  • address (str) – recipient addresses

  • subject (str) – subject of letter

  • body (str) – body of letter

  • fromAddress (str) – sender address, if “”, will be used default from CS

Returns:

S_OK(str)/S_ERROR() – str is status message

classmethod initializeHandler(serviceInfo)

Handler initialization

types_sendMail = [<class 'str'>, <class 'str'>, <class 'str'>, <class 'str'>]