public class UserDelegator extends BaseDelegator implements IUserDelegator
MAX_LIMIT_SUPPORTED_MIN_VERSION, QUERY_EXPRESSIONS_SUPPORTED_MIN_VERSION, USER_RESTRICTIONS_SUPPORTED_MIN_VERSION
Constructor and Description |
---|
UserDelegator(IOptionsServer server)
Instantiate a new UserDelegator, providing the server object that will be used to
execute Perforce Helix attribute commands.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
createUser(IUser user,
boolean force)
Create a new Perforce user on the Perforce server.
|
java.lang.String |
createUser(IUser user,
UpdateUserOptions opts)
Create a new Perforce user on the Perforce server.
|
java.lang.String |
deleteUser(java.lang.String userName,
boolean force)
Delete a named Perforce user from the Perforce server.
|
java.lang.String |
deleteUser(java.lang.String userName,
UpdateUserOptions opts)
Delete a named Perforce user from the Perforce server
|
IUser |
getUser(java.lang.String userName)
Get the user details of a specific Perforce user from the Perforce
server.
|
java.lang.String |
updateUser(IUser user,
boolean force)
Update a Perforce user on the Perforce server.
|
java.lang.String |
updateUser(IUser user,
UpdateUserOptions opts)
Update a Perforce user on the Perforce server.
|
public UserDelegator(IOptionsServer server)
server
- a concrete implementation of a Perforce Helix Serverpublic java.lang.String createUser(@Nonnull IUser user, boolean force) throws ConnectionException, RequestException, AccessException
IUserDelegator
createUser
in interface IUserDelegator
user
- non-null IUser defining the new user to be created.force
- if true, force the creation of any named user; requires admin
privileges,ConnectionException
- if the Perforce server is unreachable or is not connected.RequestException
- if the Perforce server encounters an error during its
processing of the requestAccessException
- if the Perforce server denies access to the callerpublic java.lang.String createUser(@Nonnull IUser user, UpdateUserOptions opts) throws P4JavaException
IUserDelegator
createUser
in interface IUserDelegator
user
- non-null IUser defining the new user to be created.opts
- UpdateUserOptions object describing optional parameters; if
null, no options are setP4JavaException
- if any error occurs in the processing of this method.public java.lang.String updateUser(@Nonnull IUser user, boolean force) throws ConnectionException, RequestException, AccessException
IUserDelegator
updateUser
in interface IUserDelegator
user
- non-null IUser defining the user to be updatedforce
- if true, force update for users other than the caller.
Requires super user / admin privileges (enforced by the
server).ConnectionException
- if the Perforce server is unreachable or is not connected.RequestException
- if the Perforce server encounters an error during its
processing of the requestAccessException
- if the Perforce server denies access to the callerpublic java.lang.String updateUser(@Nonnull IUser user, UpdateUserOptions opts) throws P4JavaException
IUserDelegator
updateUser
in interface IUserDelegator
user
- non-null IUser defining the new user to be updated.opts
- UpdateUserOptions object describing optional parameters; if
null, no options are setP4JavaException
- if any error occurs in the processing of this method.public java.lang.String deleteUser(java.lang.String userName, boolean force) throws ConnectionException, RequestException, AccessException
IUserDelegator
deleteUser
in interface IUserDelegator
userName
- non-null name of the user to be deleted.force
- if true, force deletion for users other than the caller.
Requires super user / admin privileges (enforced by the
server).ConnectionException
- if the Perforce server is unreachable or is not connected.RequestException
- if the Perforce server encounters an error during its
processing of the requestAccessException
- if the Perforce server denies access to the callerpublic java.lang.String deleteUser(java.lang.String userName, UpdateUserOptions opts) throws P4JavaException
IUserDelegator
deleteUser
in interface IUserDelegator
userName
- non-null name of the user to be deleted.opts
- UpdateUserOptions object describing optional parameters; if
null, no options are setP4JavaException
- if any error occurs in the processing of this method.public IUser getUser(java.lang.String userName) throws ConnectionException, RequestException, AccessException
IUserDelegator
getUser
in interface IUserDelegator
userName
- if null, get the current user details, otherwise use the
passed-in user name.ConnectionException
- if the Perforce server is unreachable or is not connected.RequestException
- if the Perforce server encounters an error during its
processing of the requestAccessException
- if the Perforce server denies access to the caller