com.redhat.rhn.frontend.xmlrpc.org

Class OrgHandler

java.lang.Object

com.redhat.rhn.frontend.xmlrpc.BaseHandler

com.redhat.rhn.frontend.xmlrpc.org.OrgHandler

All Implemented Interfaces:

redstone.xmlrpc.XmlRpcInvocationHandler

public class OrgHandler
extends BaseHandler

OrgHandler

Field Summary

Fields inherited from class com.redhat.rhn.frontend.xmlrpc.BaseHandler

VALID

Constructor Summary

Constructors

Constructor and Description
OrgHandler()

Method Summary

Modifier and Type	Method and Description
OrgDto	create(User loggedInUser, java.lang.String orgName, java.lang.String adminLogin, java.lang.String adminPassword, java.lang.String prefix, java.lang.String firstName, java.lang.String lastName, java.lang.String email, java.lang.Boolean usePamAuth) Create a new organization.
int	delete(User loggedInUser, java.lang.Integer orgId) Delete an organization.
int	getCrashFileSizeLimit(User loggedInUser, java.lang.Integer orgId) Get organization wide crash file size limit.
OrgDto	getDetails(User loggedInUser, java.lang.Integer orgId) Returns the detailed information about an organization given the org_id.
OrgDto	getDetails(User loggedInUser, java.lang.String name) Returns the detailed information about an organization given the org_name.
java.util.Map<java.lang.String,java.lang.Object>	getPolicyForScapFileUpload(User loggedInUser, java.lang.Integer orgId) Get the status of SCAP detailed result file upload settings for the given organization.
java.util.Map<java.lang.String,java.lang.Object>	getPolicyForScapResultDeletion(User loggedInUser, java.lang.Integer orgId) Get the status of SCAP result deletion settings for the given organization.
boolean	isCrashfileUploadEnabled(User loggedInUser, java.lang.Integer orgId) Get the status of crash file upload settings for the given organization.
boolean	isCrashReportingEnabled(User loggedInUser, java.lang.Integer orgId) Get the status of crash reporting settings for the given organization.
boolean	isErrataEmailNotifsForOrg(User loggedInUser, java.lang.Integer orgId) Returns whether errata e-mail notifications are enabled for the organization
boolean	isOrgConfigManagedByOrgAdmin(User loggedInUser, java.lang.Integer orgId) Returns whether Organization Administrator is able to manage his organization configuration.
java.util.List<OrgDto>	listOrgs(User loggedInUser) Returns the list of organizations.
java.util.List	listUsers(User loggedInUser, java.lang.Integer orgId) Returns the list of active users in a given organization
java.lang.Object[]	migrateSystems(User loggedInUser, java.lang.Integer toOrgId, java.util.List<java.lang.Integer> sids) Migrate systems from one organization to another.
int	setCrashFileSizeLimit(User loggedInUser, java.lang.Integer orgId, java.lang.Integer limit) Set organization wide crash file size limit.
java.lang.Integer	setCrashfileUpload(User loggedInUser, java.lang.Integer orgId, java.lang.Boolean enable) Set the status of crash file upload settings for the given organization.
java.lang.Integer	setCrashReporting(User loggedInUser, java.lang.Integer orgId, java.lang.Boolean enable) Set the status of crash reporting settings for the given organization.
java.lang.Integer	setErrataEmailNotifsForOrg(User loggedInUser, java.lang.Integer orgId, java.lang.Boolean enable) Dis/enables errata e-mail notifications for the organization
java.lang.Integer	setOrgConfigManagedByOrgAdmin(User loggedInUser, java.lang.Integer orgId, java.lang.Boolean enable) Sets whether Organization Administrator can manage his organization configuration
int	setPolicyForScapFileUpload(User loggedInUser, java.lang.Integer orgId, java.util.Map<java.lang.String,java.lang.Object> newSettings) Set the status of SCAP detailed result file upload settings for the given organization.
int	setPolicyForScapResultDeletion(User loggedInUser, java.lang.Integer orgId, java.util.Map<java.lang.String,java.lang.Object> newSettings) Set the status of SCAP result deletion settings for the given organization.
OrgDto	updateName(User loggedInUser, java.lang.Integer orgId, java.lang.String name)

Methods inherited from class com.redhat.rhn.frontend.xmlrpc.BaseHandler

ensureConfigAdmin, ensureOrgAdmin, ensureOrgOrConfigAdmin, ensureSatAdmin, ensureSystemGroupAdmin, ensureUserRole, getLoggedInUser, invoke, providesAuthentication, setEntityAttribute, validateClientCertificate, validateEntitlements, validateMap, verifyOrgExists

Methods inherited from class java.lang.Object

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

Constructor Detail

OrgHandler

public OrgHandler()

Method Detail

create

public OrgDto create(User loggedInUser,
                     java.lang.String orgName,
                     java.lang.String adminLogin,
                     java.lang.String adminPassword,
                     java.lang.String prefix,
                     java.lang.String firstName,
                     java.lang.String lastName,
                     java.lang.String email,
                     java.lang.Boolean usePamAuth)

Create a new organization.

Parameters:

loggedInUser - The current user

orgName - Organization name. Must meet same criteria as in the web UI.

adminLogin - New administrator login name for the new org.

adminPassword - New administrator password.

prefix - New administrator's prefix.

firstName - New administrator's first name.

lastName - New administrator's last name.

email - New administrator's e-mail.

usePamAuth - Should PAM authentication be used for new administrators account.

Returns:

Newly created organization object.

listOrgs

public java.util.List<OrgDto> listOrgs(User loggedInUser)

Returns the list of organizations.

Parameters:

loggedInUser - The current user

Returns:

list of orgs.

delete

public int delete(User loggedInUser,
                  java.lang.Integer orgId)

Delete an organization.

Parameters:

loggedInUser - The current user

orgId - ID of organization to delete.

Returns:

1 on success, exception thrown otherwise.

listUsers

public java.util.List listUsers(User loggedInUser,
                                java.lang.Integer orgId)

Returns the list of active users in a given organization

Parameters:

loggedInUser - The current user

orgId - the orgId of the organization to lookup on.

Returns:

the list of users in a organization.

getDetails

public OrgDto getDetails(User loggedInUser,
                         java.lang.Integer orgId)

Returns the detailed information about an organization given the org_id.

Parameters:

loggedInUser - The current user

orgId - the orgId of the organization to lookup on.

Returns:

the list of users in a organization.

getDetails

public OrgDto getDetails(User loggedInUser,
                         java.lang.String name)

Returns the detailed information about an organization given the org_name.

Parameters:

loggedInUser - The current user

name - the name of the organization to lookup on.

Returns:

the list of users in a organization.

updateName

public OrgDto updateName(User loggedInUser,
                         java.lang.Integer orgId,
                         java.lang.String name)

Parameters:

loggedInUser - The current user

orgId - the orgId of the organization to set name on

name - the new name for the org.

Returns:

the updated org.

migrateSystems

public java.lang.Object[] migrateSystems(User loggedInUser,
                                         java.lang.Integer toOrgId,
                                         java.util.List<java.lang.Integer> sids)
                                  throws FaultException

Migrate systems from one organization to another. If executed by a Satellite administrator, the systems will be migrated from their current organization to the organization specified by the toOrgId. If executed by an organization administrator, the systems must exist in the same organization as that administrator and the systems will be migrated to the organization specified by the toOrgId. In any scenario, the origination and destination organizations must be defined in a trust.

Parameters:

loggedInUser - The current user

toOrgId - destination organization ID.

sids - System IDs.

Returns:

list of systems migrated.

Throws:

FaultException - A FaultException is thrown if: - The user performing the request is not an organization administrator - The user performing the request is not a satellite administrator, but the from org id is different than the user's org id. - The from and to org id provided are the same. - One or more of the servers provides do not exist - The origination or destination organization does not exist - The user is not defined in the destination organization's trust

getCrashFileSizeLimit

public int getCrashFileSizeLimit(User loggedInUser,
                                 java.lang.Integer orgId)

Get organization wide crash file size limit.

Parameters:

loggedInUser - The current user

orgId - Organization ID to set the limit for.

Returns:

Returns the organization wide crash file size limit.

setCrashFileSizeLimit

public int setCrashFileSizeLimit(User loggedInUser,
                                 java.lang.Integer orgId,
                                 java.lang.Integer limit)

Set organization wide crash file size limit.

Parameters:

loggedInUser - The current user

orgId - Organization ID to set the limit for.

limit - The limit to set.

Returns:

1 on success.

isCrashReportingEnabled

public boolean isCrashReportingEnabled(User loggedInUser,
                                       java.lang.Integer orgId)

Get the status of crash reporting settings for the given organization.

Parameters:

loggedInUser - The current user

orgId - Organization ID to set the limit for.

Returns:

Returns the status of crash reporting settings.

setCrashReporting

public java.lang.Integer setCrashReporting(User loggedInUser,
                                           java.lang.Integer orgId,
                                           java.lang.Boolean enable)

Set the status of crash reporting settings for the given organization.

Parameters:

loggedInUser - The current user

orgId - Organization ID to set the limit for.

enable - Boolean to indicate desired settings.

Returns:

Returns 1 for successfull change, traceback otherwise.

isCrashfileUploadEnabled

public boolean isCrashfileUploadEnabled(User loggedInUser,
                                        java.lang.Integer orgId)

Get the status of crash file upload settings for the given organization.

Parameters:

loggedInUser - The current user

orgId - Organization ID to set the limit for.

Returns:

Returns the status of crash file upload settings.

setCrashfileUpload

public java.lang.Integer setCrashfileUpload(User loggedInUser,
                                            java.lang.Integer orgId,
                                            java.lang.Boolean enable)

Set the status of crash file upload settings for the given organization.

Parameters:

loggedInUser - The current user

orgId - Organization ID to set the limit for.

enable - Boolean to indicate desired settings.

Returns:

Returns 1 for successfull change, 0 if the change failed.

getPolicyForScapFileUpload

public java.util.Map<java.lang.String,java.lang.Object> getPolicyForScapFileUpload(User loggedInUser,
                                                                                   java.lang.Integer orgId)

Get the status of SCAP detailed result file upload settings for the given organization.

Parameters:

loggedInUser - The current user

orgId - ID of organization to query.

Returns:

Returns the status of SCAP detailed result file upload settings.

setPolicyForScapFileUpload

public int setPolicyForScapFileUpload(User loggedInUser,
                                      java.lang.Integer orgId,
                                      java.util.Map<java.lang.String,java.lang.Object> newSettings)

Set the status of SCAP detailed result file upload settings for the given organization.

Parameters:

loggedInUser - The current user

orgId - ID of organization to work with.

newSettings - New settings of the SCAP detailed result file upload.

Returns:

Returns 1 for successfull change.

getPolicyForScapResultDeletion

public java.util.Map<java.lang.String,java.lang.Object> getPolicyForScapResultDeletion(User loggedInUser,
                                                                                       java.lang.Integer orgId)

Get the status of SCAP result deletion settings for the given organization.

Parameters:

loggedInUser - The current user

orgId - ID of organization to query.

Returns:

Returns the status of SCAP result deletion settings.

setPolicyForScapResultDeletion

public int setPolicyForScapResultDeletion(User loggedInUser,
                                          java.lang.Integer orgId,
                                          java.util.Map<java.lang.String,java.lang.Object> newSettings)

Set the status of SCAP result deletion settings for the given organization.

Parameters:

loggedInUser - The current user

orgId - ID of organization to work with.

newSettings - New settings of the SCAP result deletion settings.

Returns:

Returns 1 for successfull change.

isOrgConfigManagedByOrgAdmin

public boolean isOrgConfigManagedByOrgAdmin(User loggedInUser,
                                            java.lang.Integer orgId)

Returns whether Organization Administrator is able to manage his organization configuration. This organization configuration may have a high impact on the whole Spacewalk/Satellite performance

Parameters:

loggedInUser - The current user

orgId - affected organization

Returns:

Returns the status org admin management setting

setOrgConfigManagedByOrgAdmin

public java.lang.Integer setOrgConfigManagedByOrgAdmin(User loggedInUser,
                                                       java.lang.Integer orgId,
                                                       java.lang.Boolean enable)

Sets whether Organization Administrator can manage his organization configuration

Parameters:

loggedInUser - The current user

orgId - affected organization id

enable - boolean to indicate permissions of Organization Administrator to manage organization configuration

Returns:

Returns 1 for successful change, exception otherwise

isErrataEmailNotifsForOrg

public boolean isErrataEmailNotifsForOrg(User loggedInUser,
                                         java.lang.Integer orgId)

Returns whether errata e-mail notifications are enabled for the organization

Parameters:

loggedInUser - The current user

orgId - affected organization

Returns:

Returns the status of the errata e-mail notification setting for the organization

setErrataEmailNotifsForOrg

public java.lang.Integer setErrataEmailNotifsForOrg(User loggedInUser,
                                                    java.lang.Integer orgId,
                                                    java.lang.Boolean enable)

Dis/enables errata e-mail notifications for the organization

Parameters:

loggedInUser - The current user

orgId - affected organization id

enable - boolean to indicate errata e-mail notifications are enabled for the organization

Returns:

Returns 1 for successful change, exception otherwise