com.redhat.rhn.frontend.xmlrpc.user.external

Class UserExternalHandler

java.lang.Object

com.redhat.rhn.frontend.xmlrpc.BaseHandler

com.redhat.rhn.frontend.xmlrpc.user.external.UserExternalHandler

All Implemented Interfaces:

redstone.xmlrpc.XmlRpcInvocationHandler

public class UserExternalHandler
extends BaseHandler

UserHandler

Field Summary

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

VALID

Constructor Summary

Constructors

Constructor and Description
UserExternalHandler()

Method Summary

Modifier and Type	Method and Description
UserExtGroup	createExternalGroupToRoleMap(User loggedInUser, java.lang.String name, java.util.List<java.lang.String> roles) Create a new external user group
OrgUserExtGroup	createExternalGroupToSystemGroupMap(User loggedInUser, java.lang.String name, java.util.List<java.lang.String> groupNames) Create a new external user group
int	deleteExternalGroupToRoleMap(User loggedInUser, java.lang.String name) delete an external user group
int	deleteExternalGroupToSystemGroupMap(User loggedInUser, java.lang.String name) delete an external user group
int	getDefaultOrg(User loggedInUser) Get the value of EXT_AUTH_DEFAULT_ORGID
UserExtGroup	getExternalGroupToRoleMap(User loggedInUser, java.lang.String name) Get a external user group
OrgUserExtGroup	getExternalGroupToSystemGroupMap(User loggedInUser, java.lang.String name) Get a external user group
boolean	getKeepTemporaryRoles(User loggedInUser) Get the value of EXT_AUTH_KEEP_ROLES
boolean	getUseOrgUnit(User loggedInUser) Get the value of EXT_AUTH_USE_ORGUNIT
java.util.List<UserExtGroup>	listExternalGroupToRoleMaps(User loggedInUser) delete an external user group
java.util.List<OrgUserExtGroup>	listExternalGroupToSystemGroupMaps(User loggedInUser) delete an external user group
int	setDefaultOrg(User loggedInUser, java.lang.Integer defaultOrg) Set the value of EXT_AUTH_DEFAULT_ORGID
int	setExternalGroupRoles(User loggedInUser, java.lang.String name, java.util.List<java.lang.String> roles) update a external user group
int	setExternalGroupSystemGroups(User loggedInUser, java.lang.String name, java.util.List<java.lang.String> groupNames) update a external user group
int	setKeepTemporaryRoles(User loggedInUser, java.lang.Boolean keepRoles) Set the value of EXT_AUTH_KEEP_ROLES
int	setUseOrgUnit(User loggedInUser, java.lang.Boolean useOrgUnit) Set the value of EXT_AUTH_USE_ORGUNIT

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

UserExternalHandler

public UserExternalHandler()

Method Detail

setKeepTemporaryRoles

public int setKeepTemporaryRoles(User loggedInUser,
                                 java.lang.Boolean keepRoles)
                          throws PermissionCheckFailureException

Set the value of EXT_AUTH_KEEP_ROLES

Parameters:

loggedInUser - The current user

keepRoles - True if we should keep temporary roles between login sessions

Returns:

1 on success

Throws:

PermissionCheckFailureException - if the user is not a Sat admin

getKeepTemporaryRoles

public boolean getKeepTemporaryRoles(User loggedInUser)
                              throws PermissionCheckFailureException

Get the value of EXT_AUTH_KEEP_ROLES

Parameters:

loggedInUser - The current user

Returns:

True if we should keep roles after users log in through non-IPA method, false otherwise.

Throws:

PermissionCheckFailureException - if the user is not a Sat admin

setUseOrgUnit

public int setUseOrgUnit(User loggedInUser,
                         java.lang.Boolean useOrgUnit)
                  throws PermissionCheckFailureException

Set the value of EXT_AUTH_USE_ORGUNIT

Parameters:

loggedInUser - The current user

useOrgUnit - True if we should keep pay attention to the Org Unit from IPA

Returns:

1 on success

Throws:

PermissionCheckFailureException - if the user is not a Sat admin

getUseOrgUnit

public boolean getUseOrgUnit(User loggedInUser)
                      throws PermissionCheckFailureException

Get the value of EXT_AUTH_USE_ORGUNIT

Parameters:

loggedInUser - The current user

Returns:

True if we should use org unit

Throws:

PermissionCheckFailureException - if the user is not a Sat admin

setDefaultOrg

public int setDefaultOrg(User loggedInUser,
                         java.lang.Integer defaultOrg)
                  throws PermissionCheckFailureException

Set the value of EXT_AUTH_DEFAULT_ORGID

Parameters:

loggedInUser - The current user

defaultOrg - the orgId that we want to use as the default org

Returns:

1 on success

Throws:

PermissionCheckFailureException - if the user is not a Sat admin

getDefaultOrg

public int getDefaultOrg(User loggedInUser)
                  throws PermissionCheckFailureException

Get the value of EXT_AUTH_DEFAULT_ORGID

Parameters:

loggedInUser - The current user

Returns:

orgId of the default org

Throws:

PermissionCheckFailureException - if the user is not a Sat admin

createExternalGroupToRoleMap

public UserExtGroup createExternalGroupToRoleMap(User loggedInUser,
                                                 java.lang.String name,
                                                 java.util.List<java.lang.String> roles)

Create a new external user group

Parameters:

loggedInUser - The current user

name - The name of the new group

roles - List of roles to set for this group

Returns:

the newly created group

Throws:

PermissionCheckFailureException - if the user is not a Sat admin

getExternalGroupToRoleMap

public UserExtGroup getExternalGroupToRoleMap(User loggedInUser,
                                              java.lang.String name)

Get a external user group

Parameters:

loggedInUser - The current user

name - The name of the group

Returns:

the group

Throws:

PermissionCheckFailureException - if the user is not a Sat admin

setExternalGroupRoles

public int setExternalGroupRoles(User loggedInUser,
                                 java.lang.String name,
                                 java.util.List<java.lang.String> roles)

update a external user group

Parameters:

loggedInUser - The current user

name - The name of the group

roles - the roles to set

Returns:

1 if successful, error otherwise

deleteExternalGroupToRoleMap

public int deleteExternalGroupToRoleMap(User loggedInUser,
                                        java.lang.String name)

delete an external user group

Parameters:

loggedInUser - The current user

name - The name of the group

Returns:

1 if successful, error otherwise

Throws:

PermissionCheckFailureException - if the user is not a Sat admin

listExternalGroupToRoleMaps

public java.util.List<UserExtGroup> listExternalGroupToRoleMaps(User loggedInUser)

delete an external user group

Parameters:

loggedInUser - The current user

Returns:

the external groups

Throws:

PermissionCheckFailureException - if the user is not a Sat admin

createExternalGroupToSystemGroupMap

public OrgUserExtGroup createExternalGroupToSystemGroupMap(User loggedInUser,
                                                           java.lang.String name,
                                                           java.util.List<java.lang.String> groupNames)

Create a new external user group

Parameters:

loggedInUser - The current user

name - The name of the new group

groupNames - List of system groups to set for this group

Returns:

the newly created group

getExternalGroupToSystemGroupMap

public OrgUserExtGroup getExternalGroupToSystemGroupMap(User loggedInUser,
                                                        java.lang.String name)

Get a external user group

Parameters:

loggedInUser - The current user

name - The name of the group

Returns:

the group

setExternalGroupSystemGroups

public int setExternalGroupSystemGroups(User loggedInUser,
                                        java.lang.String name,
                                        java.util.List<java.lang.String> groupNames)

update a external user group

Parameters:

loggedInUser - The current user

name - The name of the group

groupNames - the groups to set

Returns:

1 if successful, error otherwise

deleteExternalGroupToSystemGroupMap

public int deleteExternalGroupToSystemGroupMap(User loggedInUser,
                                               java.lang.String name)

delete an external user group

Parameters:

loggedInUser - The current user

name - The name of the group

Returns:

1 if successful, error otherwise

listExternalGroupToSystemGroupMaps

public java.util.List<OrgUserExtGroup> listExternalGroupToSystemGroupMaps(User loggedInUser)

delete an external user group

Parameters:

loggedInUser - The current user

Returns:

the external groups

Throws:

PermissionCheckFailureException - if the user is not an Org admin