com.perforce.p4java.server.delegator

Interface IUserDelegator

All Known Subinterfaces:

IOptionsServer, IServer, IStreamingServer

All Known Implementing Classes:

NtsServerImpl, OneShotServerImpl, RpcServer, Server, UserDelegator

public interface IUserDelegator

Interface to handle the User command.

Method Summary

Modifier and Type	Method and Description
String	createUser(IUser user, boolean force) Create a new Perforce user on the Perforce server.
String	createUser(IUser user, UpdateUserOptions opts) Create a new Perforce user on the Perforce server.
String	deleteUser(String userName, boolean force) Delete a named Perforce user from the Perforce server.
String	deleteUser(String userName, UpdateUserOptions opts) Delete a named Perforce user from the Perforce server
IUser	getUser(String userName) Get the user details of a specific Perforce user from the Perforce server.
String	updateUser(IUser user, boolean force) Update a Perforce user on the Perforce server.
String	updateUser(IUser user, UpdateUserOptions opts) Update a Perforce user on the Perforce server.

Method Detail

createUser

String createUser(@Nonnull
                  IUser user,
                  boolean force)
           throws ConnectionException,
                  RequestException,
                  AccessException

Create a new Perforce user on the Perforce server.

Parameters:

user - non-null IUser defining the new user to be created.

force - if true, force the creation of any named user; requires admin privileges,

Returns:

possibly-null status message string as returned from the server

Throws:

ConnectionException - if the Perforce server is unreachable or is not connected.

RequestException - if the Perforce server encounters an error during its processing of the request

AccessException - if the Perforce server denies access to the caller

createUser

String createUser(@Nonnull
                  IUser user,
                  UpdateUserOptions opts)
           throws P4JavaException

Create a new Perforce user on the Perforce server.

Parameters:

user - non-null IUser defining the new user to be created.

opts - UpdateUserOptions object describing optional parameters; if null, no options are set

Returns:

possibly-null status message string as returned from the server

Throws:

P4JavaException - if any error occurs in the processing of this method.

updateUser

String updateUser(@Nonnull
                  IUser user,
                  boolean force)
           throws ConnectionException,
                  RequestException,
                  AccessException

Update a Perforce user on the Perforce server.

Parameters:

user - non-null IUser defining the user to be updated

force - if true, force update for users other than the caller. Requires super user / admin privileges (enforced by the server).

Returns:

possibly-null status message string as returned from the server

Throws:

ConnectionException - if the Perforce server is unreachable or is not connected.

RequestException - if the Perforce server encounters an error during its processing of the request

AccessException - if the Perforce server denies access to the caller

updateUser

String updateUser(@Nonnull
                  IUser user,
                  UpdateUserOptions opts)
           throws P4JavaException

Update a Perforce user on the Perforce server.

Parameters:

user - non-null IUser defining the new user to be updated.

opts - UpdateUserOptions object describing optional parameters; if null, no options are set

Returns:

possibly-null status message string as returned from the server

Throws:

P4JavaException - if any error occurs in the processing of this method.

deleteUser

String deleteUser(String userName,
                  boolean force)
           throws ConnectionException,
                  RequestException,
                  AccessException

Delete a named Perforce user from the Perforce server.

Parameters:

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).

Returns:

possibly-null status message string as returned from the server

Throws:

ConnectionException - if the Perforce server is unreachable or is not connected.

RequestException - if the Perforce server encounters an error during its processing of the request

AccessException - if the Perforce server denies access to the caller

deleteUser

String deleteUser(String userName,
                  UpdateUserOptions opts)
           throws P4JavaException

Delete a named Perforce user from the Perforce server

Parameters:

userName - non-null name of the user to be deleted.

opts - UpdateUserOptions object describing optional parameters; if null, no options are set

Returns:

possibly-null status message string as returned from the server

Throws:

P4JavaException - if any error occurs in the processing of this method.

getUser

IUser getUser(String userName)
       throws ConnectionException,
              RequestException,
              AccessException

Get the user details of a specific Perforce user from the Perforce server.

Parameters:

userName - if null, get the current user details, otherwise use the passed-in user name.

Returns:

IUser details for the user, or null if no such user is known.

Throws:

ConnectionException - if the Perforce server is unreachable or is not connected.

RequestException - if the Perforce server encounters an error during its processing of the request

AccessException - if the Perforce server denies access to the caller