com.tibco.ax.fw.cfg.api

Interface IUsers

public interface IUsers

Method Summary

Methods

Modifier and Type	Method and Description
void	createAdminUser(java.lang.String userName) Create a new admin user with the given name.
void	createExternalUser(java.lang.String email, java.lang.String password, java.lang.String partner, java.lang.String firstName, java.lang.String lastName) Create an external user with given email,password,firstName,lastName and partner this user belongs to.
void	createGroup(java.lang.String groupName) Create a group with given name.
void	createInternalUser(java.lang.String userName, java.lang.String password) Create an internal user with given name and password.
void	createInternalUserGroups(java.lang.String userName, java.lang.String[] groups) Join the given internal user to given groups
void	deleteAdminUser(java.lang.String userName) Delete the given admin user.
void	deleteAllInternalUserGroups(java.lang.String userName) Remove the given internal user from all groups this user belongs to.
void	deleteExternalUser(java.lang.String email) Delete the given external user.
void	deleteGroup(java.lang.String groupName) Delete given group.
void	deleteInternalUser(java.lang.String userName) Delete the given internal user.
void	deleteInternalUserGroups(java.lang.String userName, java.lang.String[] groups) Remove the given internal user from given groups
java.lang.String	retrieveExternalUserProtocolPermission(java.lang.String email, java.lang.String protocol) Retrieve given external user's permission of given protocol.
java.lang.String	retrieveGroupBusinessAgreementPermission(java.lang.String groupName, java.lang.String partner, java.lang.String host) Retrieve business agreement permission with given business agreement for given group.
java.lang.String	retrieveGroupParticipantPermission(java.lang.String groupName, java.lang.String participant) Retrieve participants permission for given group.
java.util.List	retrieveGroups() Retrieve all group.
java.lang.String	retrieveInternalUserBusinessAgreementPermission(java.lang.String userName, java.lang.String partner, java.lang.String host) Retrieve business agreement permission with given business agreement for given internal user.
java.lang.String[]	retrieveInternalUserGroups(java.lang.String userName) Retrieve the given internal user's group membership.
java.lang.String	retrieveInternalUserParticipantPermission(java.lang.String userName, java.lang.String participant) Retrieve participant permission for given internal user.
void	updateExternalUserProtocolPermission(java.lang.String email, java.lang.String protocol, java.lang.String permissions) Set given external user's permission of given protocol.
void	updateGroupBusinessAgreementPermission(java.lang.String groupName, java.lang.String partner, java.lang.String host, java.lang.String permissions) Set business agreement permission with given business agreement for given group.
void	updateGroupParticipantPermission(java.lang.String groupName, java.lang.String participant, java.lang.String permissions) Set participant permission for given group.
void	updateInternalUserBusinessAgreementPermission(java.lang.String userName, java.lang.String partner, java.lang.String host, java.lang.String permissions) Set business agreement permission with given business agreement for given internal user.
void	updateInternalUserParticipantPermission(java.lang.String userName, java.lang.String participant, java.lang.String permissions) Set participant permission for given internal user.

Method Detail

createAdminUser

void createAdminUser(java.lang.String userName)

Create a new admin user with the given name.

Parameters:

userName - name of created admin user.

deleteAdminUser

void deleteAdminUser(java.lang.String userName)

Delete the given admin user.

Parameters:

userName - name of deleted admin user.

createInternalUser

void createInternalUser(java.lang.String userName,
                      java.lang.String password)

Create an internal user with given name and password.

Parameters:

userName - name of created internal user.

password - password of created internal user.

deleteInternalUser

void deleteInternalUser(java.lang.String userName)

Delete the given internal user.

Parameters:

userName - name of deleted internal user.

retrieveInternalUserGroups

java.lang.String[] retrieveInternalUserGroups(java.lang.String userName)
                                              throws ConfigException

Retrieve the given internal user's group membership.

Parameters:

userName - name of given user.

Returns:

array of group membership of given internal user.

Throws:

ConfigException

createInternalUserGroups

void createInternalUserGroups(java.lang.String userName,
                            java.lang.String[] groups)
                              throws ConfigException

Join the given internal user to given groups

Parameters:

userName - name of given user.

groups - array of group names.

Throws:

ConfigException

deleteInternalUserGroups

void deleteInternalUserGroups(java.lang.String userName,
                            java.lang.String[] groups)
                              throws ConfigException

Remove the given internal user from given groups

Parameters:

userName - name of given user.

groups - array of group names.

Throws:

ConfigException

deleteAllInternalUserGroups

void deleteAllInternalUserGroups(java.lang.String userName)
                                 throws ConfigException

Remove the given internal user from all groups this user belongs to.

Parameters:

userName - name of given user.

Throws:

ConfigException

retrieveInternalUserParticipantPermission

java.lang.String retrieveInternalUserParticipantPermission(java.lang.String userName,
                                                         java.lang.String participant)
                                                           throws ConfigException

Retrieve participant permission for given internal user.

Parameters:

userName - name of given user.

participant - name of given participant.

Returns:

participant permission of given internal user.Options:C(create),R(retrieve),U(update),D(delete),A(all)

Throws:

ConfigException

updateInternalUserParticipantPermission

void updateInternalUserParticipantPermission(java.lang.String userName,
                                           java.lang.String participant,
                                           java.lang.String permissions)
                                             throws ConfigException

Set participant permission for given internal user.

Parameters:

userName - name of given user.

participant - name of given participant.

permissions - participant permission string.Options:C(create),R(retrieve),U(update),D(delete),A(all).i.e. CR refers to create and retrieve permissions.

Throws:

ConfigException

retrieveInternalUserBusinessAgreementPermission

java.lang.String retrieveInternalUserBusinessAgreementPermission(java.lang.String userName,
                                                               java.lang.String partner,
                                                               java.lang.String host)
                                                                 throws ConfigException

Retrieve business agreement permission with given business agreement for given internal user.

Parameters:

userName - name of given user.

partner - partner name of given business agreement.

host - host name of given business agreement.

Returns:

business agreement permission with given business agreement and internal user.Options:C(create),R(retrieve),U(update),D(delete),A(all)

Throws:

ConfigException

updateInternalUserBusinessAgreementPermission

void updateInternalUserBusinessAgreementPermission(java.lang.String userName,
                                                 java.lang.String partner,
                                                 java.lang.String host,
                                                 java.lang.String permissions)
                                                   throws ConfigException

Set business agreement permission with given business agreement for given internal user.

Parameters:

userName - name of given user.

partner - partner name of given business agreement.

host - host name of given business agreement.

permissions - business agreement permission string.Options:C(create),R(retrieve),U(update),D(delete),A(all).i.e. CR refers to create and retrieve permissions.

Throws:

ConfigException

createExternalUser

void createExternalUser(java.lang.String email,
                      java.lang.String password,
                      java.lang.String partner,
                      java.lang.String firstName,
                      java.lang.String lastName)
                        throws ConfigException

Create an external user with given email,password,firstName,lastName and partner this user belongs to.

Parameters:

email - email of created external user.

password - password of created external user.

partner - partner the created external user belongs to.

firstName - first name of created external user.

lastName - last name of created external user.

Throws:

ConfigException

deleteExternalUser

void deleteExternalUser(java.lang.String email)

Delete the given external user.

Parameters:

email - email of deleted external user.

retrieveExternalUserProtocolPermission

java.lang.String retrieveExternalUserProtocolPermission(java.lang.String email,
                                                      java.lang.String protocol)
                                                        throws ConfigException

Retrieve given external user's permission of given protocol.

Parameters:

email - email of given external user.

protocol - name of given protocol.

Returns:

given external user's permission for given protocol.Please refer to the related user guide documentation for all the supported permissions of the specified protocol.

Throws:

ConfigException

updateExternalUserProtocolPermission

void updateExternalUserProtocolPermission(java.lang.String email,
                                        java.lang.String protocol,
                                        java.lang.String permissions)
                                          throws ConfigException

Set given external user's permission of given protocol.

Parameters:

email - email of given external user.

protocol - name of given protocol.

permissions - external user permission for given protocol.Please refer to the related user guide documentation for all the supported permissions of the specified protocol.

Throws:

ConfigException

createGroup

void createGroup(java.lang.String groupName)
                 throws ConfigException

Create a group with given name.

Parameters:

groupName - name of created group.

Throws:

ConfigException

deleteGroup

void deleteGroup(java.lang.String groupName)

Delete given group.

Parameters:

groupName - name of deleted group.

updateGroupBusinessAgreementPermission

void updateGroupBusinessAgreementPermission(java.lang.String groupName,
                                          java.lang.String partner,
                                          java.lang.String host,
                                          java.lang.String permissions)
                                            throws ConfigException

Set business agreement permission with given business agreement for given group.

Parameters:

groupName - name of given group.

partner - partner name of given business agreement.

host - name of given business agreement.

permissions - business agreement permission string.Options:C(create),R(retrieve),U(update),D(delete),A(all).i.e. CR refers to create and retrieve permissions.

Throws:

ConfigException

updateGroupParticipantPermission

void updateGroupParticipantPermission(java.lang.String groupName,
                                    java.lang.String participant,
                                    java.lang.String permissions)
                                      throws ConfigException

Set participant permission for given group.

Parameters:

groupName - name of given group.

participant - name of given participant.

permissions - permissions participant permission string.Options:C(create),R(retrieve),U(update),D(delete),A(all).i.e. CR refers to create and retrieve permissions.

Throws:

ConfigException

retrieveGroupParticipantPermission

java.lang.String retrieveGroupParticipantPermission(java.lang.String groupName,
                                                  java.lang.String participant)
                                                    throws ConfigException

Retrieve participants permission for given group.

Parameters:

groupName - name of given group.

participant - name of given participant.

Returns:

group participant permission of given group.Options:C(create),R(retrieve),U(update),D(delete),A(all)

Throws:

ConfigException

retrieveGroupBusinessAgreementPermission

java.lang.String retrieveGroupBusinessAgreementPermission(java.lang.String groupName,
                                                        java.lang.String partner,
                                                        java.lang.String host)
                                                          throws ConfigException

Retrieve business agreement permission with given business agreement for given group.

Parameters:

groupName - name of given group.

partner - partner name of given business agreement.

host - host name of given business agreement.

Returns:

business agreement permission with given business agreement and group.Options:C(create),R(retrieve),U(update),D(delete),A(all)

Throws:

ConfigException

retrieveGroups

java.util.List retrieveGroups()

Retrieve all group.

Returns:

group list of group names.