org.alfresco.repo.webservice.administration

Class AdministrationWebService

java.lang.Object

org.alfresco.repo.webservice.AbstractWebService

org.alfresco.repo.webservice.administration.AdministrationWebService

All Implemented Interfaces:

Remote, AdministrationServiceSoapPort

public class AdministrationWebService
extends AbstractWebService
implements AdministrationServiceSoapPort

Author:

Roy Wetherall

Field Summary

Fields inherited from class org.alfresco.repo.webservice.AbstractWebService

contentService, dictionaryService, namespaceService, nodeService, querySessionCache, searchService, serviceRegistry

Constructor Summary

Constructors

Constructor and Description
AdministrationWebService() Constructor

Method Summary

Methods

Modifier and Type	Method and Description
void	changePassword(String userName, String oldPassword, String newPassword) Changes the password of the specified user.
UserDetails[]	createUsers(NewUserDetails[] newUsers) Create new users with the details provided.
void	deleteUsers(String[] userNames) Delete the specified users.
UserQueryResults	fetchMoreUsers(String querySession) Fetch the next bathc of users from an existing user query.
UserDetails	getUser(String userName) Get the details of a specified user.
UserQueryResults	queryUsers(UserFilter filter) Gets the details of the requested users.
void	setAuthenticationService(MutableAuthenticationService authenticationService) Set the authentication service
void	setAuthorityService(AuthorityService authorityService) Set the authority service used to determine admin rights.
void	setManageAuthenticationDetails(boolean manageAuthenticationDetails) Set the flag that indicates whether this service should manage user authentication details as well as person details.
void	setPersonService(PersonService personService) Set the person service
void	setTransactionService(TransactionService transactionService) Set the transaction service
UserDetails[]	updateUsers(UserDetails[] users) Updates the details of the specified users.

Methods inherited from class org.alfresco.repo.webservice.AbstractWebService

setContentService, setDictionaryService, setNamespaceService, setNodeService, setQuerySessionCache, setSearchService, setServiceRegistry

Methods inherited from class java.lang.Object

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

Constructor Detail

AdministrationWebService

public AdministrationWebService()

Constructor

Method Detail

setManageAuthenticationDetails

public void setManageAuthenticationDetails(boolean manageAuthenticationDetails)

Set the flag that indicates whether this service should manage user authentication details as well as person details.

Parameters:

manageAuthenticationDetails - true if authentication details are managed, false otherwise

setTransactionService

public void setTransactionService(TransactionService transactionService)

Set the transaction service

Parameters:

transactionService - the transaction service

setPersonService

public void setPersonService(PersonService personService)

Set the person service

Parameters:

personService - sets the person service

setAuthenticationService

public void setAuthenticationService(MutableAuthenticationService authenticationService)

Set the authentication service

Parameters:

authenticationService - the authentication service

setAuthorityService

public void setAuthorityService(AuthorityService authorityService)

Set the authority service used to determine admin rights.

Parameters:

authorityService - the service implementation

queryUsers

public UserQueryResults queryUsers(UserFilter filter)
                            throws RemoteException,
                                   AdministrationFault

Description copied from interface: AdministrationServiceSoapPort

Gets the details of the requested users.

Specified by:

queryUsers in interface AdministrationServiceSoapPort

Throws:

RemoteException

AdministrationFault

See Also:

AdministrationServiceSoapPort.queryUsers(org.alfresco.repo.webservice.administration.UserFilter)

fetchMoreUsers

public UserQueryResults fetchMoreUsers(String querySession)
                                throws RemoteException,
                                       AdministrationFault

Description copied from interface: AdministrationServiceSoapPort

Fetch the next bathc of users from an existing user query.

Specified by:

fetchMoreUsers in interface AdministrationServiceSoapPort

Throws:

RemoteException

AdministrationFault

See Also:

AdministrationServiceSoapPort.fetchMoreUsers(java.lang.String)

getUser

public UserDetails getUser(String userName)
                    throws RemoteException,
                           AdministrationFault

Description copied from interface: AdministrationServiceSoapPort

Get the details of a specified user.

Specified by:

getUser in interface AdministrationServiceSoapPort

Throws:

RemoteException

AdministrationFault

See Also:

AdministrationServiceSoapPort.getUser(java.lang.String)

createUsers

public UserDetails[] createUsers(NewUserDetails[] newUsers)
                          throws RemoteException,
                                 AdministrationFault

Description copied from interface: AdministrationServiceSoapPort

Create new users with the details provided.

Specified by:

createUsers in interface AdministrationServiceSoapPort

Throws:

RemoteException

AdministrationFault

See Also:

AdministrationServiceSoapPort.createUsers(org.alfresco.repo.webservice.administration.NewUserDetails[])

updateUsers

public UserDetails[] updateUsers(UserDetails[] users)
                          throws RemoteException,
                                 AdministrationFault

Description copied from interface: AdministrationServiceSoapPort

Updates the details of the specified users.

Specified by:

updateUsers in interface AdministrationServiceSoapPort

Throws:

RemoteException

AdministrationFault

See Also:

AdministrationServiceSoapPort.updateUsers(org.alfresco.repo.webservice.administration.UserDetails[])

changePassword

public void changePassword(String userName,
                  String oldPassword,
                  String newPassword)
                    throws RemoteException,
                           AdministrationFault

Description copied from interface: AdministrationServiceSoapPort

Changes the password of the specified user.

Specified by:

changePassword in interface AdministrationServiceSoapPort

Throws:

RemoteException

AdministrationFault

See Also:

AdministrationServiceSoapPort.changePassword(java.lang.String, java.lang.String, java.lang.String)

deleteUsers

public void deleteUsers(String[] userNames)
                 throws RemoteException,
                        AdministrationFault

Description copied from interface: AdministrationServiceSoapPort

Delete the specified users.

Specified by:

deleteUsers in interface AdministrationServiceSoapPort

Throws:

RemoteException

AdministrationFault

See Also:

AdministrationServiceSoapPort.deleteUsers(java.lang.String[])