OXUser (SOAP service interface)

Overview

Package

Class

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

com.openexchange.admin.soap
Class OXUser

java.lang.Object
  com.openexchange.admin.soap.OXSOAPRMIMapper
      com.openexchange.admin.soap.OXUser

public class OXUser
extends OXSOAPRMIMapper
extends OXSOAPRMIMapper

SOAP Service implementing RMI Interface OXUserInterface

Author:: choeger

Field Summary

Fields inherited from class com.openexchange.admin.soap.OXSOAPRMIMapper
`CONNECT_ATTEMPTS_DELAY_TIME, LOCK_WAIT_TIME, MAX_RMI_CONNECT_ATTEMPTS, RMI_HOSTNAME`

Constructor Summary
`OXUser()`

Method Summary
`void`	`change(Context ctx, User usrdata, Credentials auth)` Same as `OXUserInterface.change(Context, User, Credentials)`
`void`	`changeByModuleAccess(Context ctx, User user, UserModuleAccess moduleAccess, Credentials auth)` Same as `OXUserInterface.changeModuleAccess(Context, User, UserModuleAccess, Credentials)`
`void`	`changeByModuleAccessName(Context ctx, User user, String access_combination_name, Credentials auth)` Same as `OXUserInterface.changeModuleAccess(Context, User, String, Credentials)`
`void`	`changeModuleAccessGlobal(String filter, UserModuleAccess addAccess, UserModuleAccess removeAccess, Credentials auth)` This method changes module Permissions for all (!) users in all (!) contexts.
`User`	`create(Context ctx, User usrdata, Credentials auth)` Same as `OXUserInterface.create(Context, User, Credentials)`
`User`	`createByModuleAccess(Context ctx, User usrdata, UserModuleAccess access, Credentials auth)` Same as `OXUserInterface.create(Context, User, UserModuleAccess, Credentials)`
`User`	`createByModuleAccessName(Context ctx, User usrdata, String access_combination_name, Credentials auth)` Same as `OXUserInterface.create(Context, User, String, Credentials)`
`void`	`delete(Context ctx, User user, Credentials auth)` Same as `OXUserInterface.delete(Context, User, Credentials)`
`void`	`deleteMultiple(Context ctx, User[] users, Credentials auth)` Same as `OXUserInterface.delete(Context, User[], Credentials)`
`boolean`	`exists(Context ctx, User user, Credentials auth)` Same as `OXUserInterface.exists(com.openexchange.admin.rmi.dataobjects.Context, com.openexchange.admin.rmi.dataobjects.User, Credentials)`
`String`	`getAccessCombinationName(Context ctx, User user, Credentials auth)` Same as `OXUserInterface.getAccessCombinationName(Context, User, Credentials)`
`User`	`getContextAdmin(Context ctx, Credentials auth)` Same as `OXUserInterface.getContextAdmin(Context, Credentials)`
`User`	`getData(Context ctx, User user, Credentials auth)` Same as `OXUserInterface.getData(Context, User, Credentials)`
`UserModuleAccess`	`getModuleAccess(Context ctx, User user, Credentials auth)` Same as `OXUserInterface.getModuleAccess(Context, User, Credentials)`
`User[]`	`getMultipleData(Context ctx, User[] users, Credentials auth)` Same as `OXUserInterface.getData(Context, User[], Credentials)`
`User[]`	`list(Context ctx, String search_pattern, Credentials auth)` Same as `OXUserInterface.list(Context, String, Credentials)`
`User[]`	`listAll(Context ctx, Credentials auth)` Same as `OXUserInterface.listAll(Context, Credentials)`
`User[]`	`listCaseInsensitive(Context ctx, String search_pattern, Credentials auth)` Same as `OXUserInterface.listCaseInsensitive(com.openexchange.admin.rmi.dataobjects.Context, String, Credentials)`

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

OXUser

public OXUser()
       throws RemoteException

Throws:: RemoteException

Method Detail

change

public void change(Context ctx,
                   User usrdata,
                   Credentials auth)
            throws RemoteException,
                   StorageException,
                   InvalidCredentialsException,
                   NoSuchContextException,
                   InvalidDataException,
                   DatabaseUpdateException,
                   NoSuchUserException

Same as OXUserInterface.change(Context, User, Credentials)

Parameters:: ctx -; usrdata -; auth -
Throws:: RemoteException; StorageException; InvalidCredentialsException; NoSuchContextException; InvalidDataException; DatabaseUpdateException; NoSuchUserException

changeByModuleAccess

public void changeByModuleAccess(Context ctx,
                                 User user,
                                 UserModuleAccess moduleAccess,
                                 Credentials auth)
                          throws RemoteException,
                                 StorageException,
                                 InvalidCredentialsException,
                                 NoSuchContextException,
                                 InvalidDataException,
                                 DatabaseUpdateException,
                                 NoSuchUserException

Same as OXUserInterface.changeModuleAccess(Context, User, UserModuleAccess, Credentials)

Parameters:: ctx -; user -; moduleAccess -; auth -
Throws:: RemoteException; StorageException; InvalidCredentialsException; NoSuchContextException; InvalidDataException; DatabaseUpdateException; NoSuchUserException

changeByModuleAccessName

public void changeByModuleAccessName(Context ctx,
                                     User user,
                                     String access_combination_name,
                                     Credentials auth)
                              throws RemoteException,
                                     StorageException,
                                     InvalidCredentialsException,
                                     NoSuchContextException,
                                     InvalidDataException,
                                     DatabaseUpdateException,
                                     NoSuchUserException

Same as OXUserInterface.changeModuleAccess(Context, User, String, Credentials)

Parameters:: ctx -; user -; access_combination_name -; auth -
Throws:: RemoteException; StorageException; InvalidCredentialsException; NoSuchContextException; InvalidDataException; DatabaseUpdateException; NoSuchUserException

createByModuleAccess

public User createByModuleAccess(Context ctx,
                                 User usrdata,
                                 UserModuleAccess access,
                                 Credentials auth)
                          throws RemoteException,
                                 StorageException,
                                 InvalidCredentialsException,
                                 NoSuchContextException,
                                 InvalidDataException,
                                 DatabaseUpdateException

Same as OXUserInterface.create(Context, User, UserModuleAccess, Credentials)

Parameters:: ctx -; usrdata -; access -; auth -
Returns:
Throws:: RemoteException; StorageException; InvalidCredentialsException; NoSuchContextException; InvalidDataException; DatabaseUpdateException

createByModuleAccessName

public User createByModuleAccessName(Context ctx,
                                     User usrdata,
                                     String access_combination_name,
                                     Credentials auth)
                              throws RemoteException,
                                     StorageException,
                                     InvalidCredentialsException,
                                     NoSuchContextException,
                                     InvalidDataException,
                                     DatabaseUpdateException

Same as OXUserInterface.create(Context, User, String, Credentials)

Parameters:: ctx -; usrdata -; access_combination_name -; auth -
Returns:
Throws:: RemoteException; StorageException; InvalidCredentialsException; NoSuchContextException; InvalidDataException; DatabaseUpdateException

create

public User create(Context ctx,
                   User usrdata,
                   Credentials auth)
            throws RemoteException,
                   StorageException,
                   InvalidCredentialsException,
                   NoSuchContextException,
                   InvalidDataException,
                   DatabaseUpdateException

Same as OXUserInterface.create(Context, User, Credentials)

Parameters:: ctx -; usrdata -; auth -
Returns:
Throws:: RemoteException; StorageException; InvalidCredentialsException; NoSuchContextException; InvalidDataException; DatabaseUpdateException

deleteMultiple

public void deleteMultiple(Context ctx,
                           User[] users,
                           Credentials auth)
                    throws RemoteException,
                           StorageException,
                           InvalidCredentialsException,
                           NoSuchContextException,
                           InvalidDataException,
                           DatabaseUpdateException,
                           NoSuchUserException

Same as OXUserInterface.delete(Context, User[], Credentials)

Parameters:: ctx -; users -; auth -
Throws:: RemoteException; StorageException; InvalidCredentialsException; NoSuchContextException; InvalidDataException; DatabaseUpdateException; NoSuchUserException

delete

public void delete(Context ctx,
                   User user,
                   Credentials auth)
            throws RemoteException,
                   StorageException,
                   InvalidCredentialsException,
                   NoSuchContextException,
                   InvalidDataException,
                   DatabaseUpdateException,
                   NoSuchUserException

Same as OXUserInterface.delete(Context, User, Credentials)

Parameters:: ctx -; user -; auth -
Throws:: RemoteException; StorageException; InvalidCredentialsException; NoSuchContextException; InvalidDataException; DatabaseUpdateException; NoSuchUserException

getAccessCombinationName

public String getAccessCombinationName(Context ctx,
                                       User user,
                                       Credentials auth)
                                throws RemoteException,
                                       StorageException,
                                       InvalidCredentialsException,
                                       NoSuchContextException,
                                       InvalidDataException,
                                       DatabaseUpdateException,
                                       NoSuchUserException

Same as OXUserInterface.getAccessCombinationName(Context, User, Credentials)

Parameters:: ctx -; user -; auth -
Returns:
Throws:: RemoteException; StorageException; InvalidCredentialsException; NoSuchContextException; InvalidDataException; DatabaseUpdateException; NoSuchUserException

getMultipleData

public User[] getMultipleData(Context ctx,
                              User[] users,
                              Credentials auth)
                       throws RemoteException,
                              StorageException,
                              InvalidCredentialsException,
                              NoSuchContextException,
                              InvalidDataException,
                              NoSuchUserException,
                              DatabaseUpdateException

Same as OXUserInterface.getData(Context, User[], Credentials)

Parameters:: ctx -; users -; auth -
Returns:
Throws:: RemoteException; StorageException; InvalidCredentialsException; NoSuchContextException; InvalidDataException; NoSuchUserException; DatabaseUpdateException

getData

public User getData(Context ctx,
                    User user,
                    Credentials auth)
             throws RemoteException,
                    StorageException,
                    InvalidCredentialsException,
                    NoSuchContextException,
                    InvalidDataException,
                    NoSuchUserException,
                    DatabaseUpdateException

Same as OXUserInterface.getData(Context, User, Credentials)

Parameters:: ctx -; user -; auth -
Returns:
Throws:: RemoteException; StorageException; InvalidCredentialsException; NoSuchContextException; InvalidDataException; NoSuchUserException; DatabaseUpdateException

getModuleAccess

public UserModuleAccess getModuleAccess(Context ctx,
                                        User user,
                                        Credentials auth)
                                 throws RemoteException,
                                        StorageException,
                                        InvalidCredentialsException,
                                        NoSuchContextException,
                                        InvalidDataException,
                                        DatabaseUpdateException,
                                        NoSuchUserException

Same as OXUserInterface.getModuleAccess(Context, User, Credentials)

Parameters:: ctx -; user -; auth -
Returns:
Throws:: RemoteException; StorageException; InvalidCredentialsException; NoSuchContextException; InvalidDataException; DatabaseUpdateException; NoSuchUserException

list

public User[] list(Context ctx,
                   String search_pattern,
                   Credentials auth)
            throws RemoteException,
                   StorageException,
                   InvalidCredentialsException,
                   NoSuchContextException,
                   InvalidDataException,
                   DatabaseUpdateException

Same as OXUserInterface.list(Context, String, Credentials)

Parameters:: ctx -; search_pattern -; auth -
Returns:
Throws:: RemoteException; StorageException; InvalidCredentialsException; NoSuchContextException; InvalidDataException; DatabaseUpdateException

listAll

public User[] listAll(Context ctx,
                      Credentials auth)
               throws RemoteException,
                      StorageException,
                      InvalidCredentialsException,
                      NoSuchContextException,
                      InvalidDataException,
                      DatabaseUpdateException

Same as OXUserInterface.listAll(Context, Credentials)

Parameters:: ctx -; auth -
Returns:
Throws:: RemoteException; StorageException; InvalidCredentialsException; NoSuchContextException; InvalidDataException; DatabaseUpdateException

changeModuleAccessGlobal

public void changeModuleAccessGlobal(String filter,
                                     UserModuleAccess addAccess,
                                     UserModuleAccess removeAccess,
                                     Credentials auth)
                              throws RemoteException,
                                     InvalidCredentialsException,
                                     StorageException,
                                     InvalidDataException

This method changes module Permissions for all (!) users in all (!) contexts. This can be filtered by already existing access combinations. If no filter is given, all users are changed.

Parameters:: filter - The call affects only users with exactly this access combination. This is either a String representing a defined module access combination or an Integer (masked as String) for direct definitions. null for no filter.; addAccess - Access rights to be added; removeAccess - Access rights to be removed; auth - Credentials for authenticating against server. Must be the master Admin.
Throws:: RemoteException; InvalidCredentialsException; StorageException; InvalidDataException

getContextAdmin

public User getContextAdmin(Context ctx,
                            Credentials auth)
                     throws RemoteException,
                            InvalidCredentialsException,
                            StorageException,
                            InvalidDataException,
                            DuplicateExtensionException

Same as OXUserInterface.getContextAdmin(Context, Credentials)

Parameters:: ctx -; auth -
Returns:
Throws:: RemoteException; InvalidCredentialsException; StorageException; InvalidDataException; DuplicateExtensionException

listCaseInsensitive

public User[] listCaseInsensitive(Context ctx,
                                  String search_pattern,
                                  Credentials auth)
                           throws RemoteException,
                                  StorageException,
                                  InvalidCredentialsException,
                                  NoSuchContextException,
                                  InvalidDataException,
                                  DatabaseUpdateException

Same as OXUserInterface.listCaseInsensitive(com.openexchange.admin.rmi.dataobjects.Context, String, Credentials)

Parameters:: ctx -; search_pattern -; auth -
Returns:
Throws:: RemoteException; DatabaseUpdateException; InvalidDataException; NoSuchContextException; InvalidCredentialsException; StorageException

exists

public boolean exists(Context ctx,
                      User user,
                      Credentials auth)
               throws RemoteException,
                      InvalidDataException,
                      InvalidCredentialsException,
                      StorageException,
                      DatabaseUpdateException,
                      NoSuchContextException

Same as

OXUserInterface.exists(com.openexchange.admin.rmi.dataobjects.Context, com.openexchange.admin.rmi.dataobjects.User, Credentials)

Parameters:: ctx -; user -; auth -
Returns:
Throws:: RemoteException; InvalidDataException; InvalidCredentialsException; StorageException; DatabaseUpdateException; NoSuchContextException