Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This will add a member to a specified Moira list.


API syntax:

 
 public boolean addMemberToList(      String       String listName,

 String memberID,

 String memberType,

 String proxyID)
throws moirawsException 

Parameters:

  •  listName:

...

  • string

...

  • that

...

  • contains

...

  • the

...

  • Moira

...

  • list

...

  • name

...

  • to

...

  • which

...

  • the

...

  • member

...

  • specified

...

  • in

...

  • the

...

  • memberID

...

  • parameter

...

  • is

...

  • to

...

  • be

...

  • added.

...

  •   This

...

  • is

...

  • a

...

  • required

...

  • parameter. 

...

  • memberID:

...

  • string

...

  • that

...

  • contains

...

  • the

...

  • member

...

  • that

...

  • is

...

  • to

...

  • be

...

  • added

...

  • to

...

  • the

...

  • Moira

...

  • list

...

  • specified

...

  • in

...

  • the

...

  • listName

...

  • parameter.

...

  •   This

...

  • is

...

  • a

...

  • required

...

  • parameter. 

...

  • memberType:

...

  • string

...

  • that

...

  • contains

...

  • the

...

  • Moira

...

  • type

...

  • of

...

  • the

...

  • member

...

  • contained

...

  • in

...

  • the

...

  • memberID

...

  • parameter.

...

  •   The

...

  • supported

...

  • Moira

...

  • memberType(s)

...

  • are:

...

  • KERBEROS,

...

  • LIST,

...

  • STRING,

...

  • USER.

...

  •   This

...

  • is

...

  • a

...

  • required

...

  • parameter. 

...

  • proxyID:

...

  • string

...

  • the

...

  • contains

...

  • the

...

  • user

...

  • upon

...

  • whose

...

  • behalf

...

  • the

...

  • web

...

  • service

...

  • is

...

  • adding

...

  • the

...

  • memberID

...

  • to

...

  • the

...

  • listName.

...

  •   This

...

  • is

...

  • usually

...

  • the

...

  • Kerberos

...

  • principal

...

  • of

...

  • a

...

  • user

...

  • who

...

  • has

...

  • administrative

...

  • access

...

  • to

...

  • the

...

  • specified

...

  • Moira

...

  • list.

...

  •   This

...

  • is

...

  • an

...

  • optional

...

  • parameter.

...

  •   If

...

  • this

...

  • parameter

...

  • is

...

  • not

...

  • used,

...

  • it

...

  • must

...

  • be

...

  • set

...

  • either

...

  • to

...

  • null

...

  • or

...

  • an

...

  • empty

...

  • stirng

...

  • (""). 

Return value:

...

The addMemberToList API returns a boolean true if the specified memberID is successfully added to the specified list.  If the member cannot be added to the specified list, either a boolean false is returned or and exception will be thrown.

...