org.connid.bundles.soap.provisioning.interfaces
Interface Provisioning

public interface Provisioning

Method Summary

String	authenticate(String username, String password) Verify user creentials
String	checkAlive() Returns "OK" if the resource is available.
String	create(List<WSAttributeValue> data) Creates user account.
String	delete(String accountid) Deletes user account.
int	getLatestChangeNumber() Gets the latest change id.
Boolean	isAuthenticationSupported() Checks if authentication is supported.
Boolean	isSyncSupported() Checks if synchronization is supported.
List<WSUser>	query(Operand query) Searches for user accounts.
String	resolve(String username) Returns accountid related to the specified username.
List<WSAttribute>	schema() Returns the schema.
List<WSChange>	sync() Returns changes to be synchronized.
String	update(String accountid, List<WSAttributeValue> data) Updates user account.

Method Detail

isAuthenticationSupported

Boolean isAuthenticationSupported()

Checks if authentication is supported.

Returns:

true if the resource support authentication.

isSyncSupported

Boolean isSyncSupported()

Checks if synchronization is supported.

Returns:

true if the resource support synchronization.

authenticate

String authenticate(String username,
                    String password)
                    throws ProvisioningException

Verify user creentials

Parameters:

username -

password -

Returns:

the accountid of the first account that match username and password.

Throws:

ProvisioningException - in case of authentication failed.

checkAlive

String checkAlive()

Returns "OK" if the resource is available.

Returns:

the string "OK" in case of availability of the resource.

schema

List<WSAttribute> schema()

Returns the schema.

Returns:

a set of attributes.

create

String create(List<WSAttributeValue> data)
              throws ProvisioningException

Creates user account.

Parameters:

a - set of account attributes.

Returns:

accountid of the account created.

Throws:

ProvisioningException - in case of failure.

update

String update(String accountid,
              List<WSAttributeValue> data)
              throws ProvisioningException

Updates user account.

Parameters:

accountid. -

a - set of attributes to be updated.

Returns:

accountid.

Throws:

ProvisioningException - in case of failure

delete

String delete(String accountid)
              throws ProvisioningException

Deletes user account.

Parameters:

accountid. -

Returns:

accountid.

Throws:

ProvisioningException - in case of failure.

query

List<WSUser> query(Operand query)

Searches for user accounts.

Parameters:

query - filter

Returns:

a set of user accounts.

resolve

String resolve(String username)
               throws ProvisioningException

Returns accountid related to the specified username.

Parameters:

username. -

Returns:

accountid or null if username not found

Throws:

ProvisioningException - in case of failure.

getLatestChangeNumber

int getLatestChangeNumber()
                          throws ProvisioningException

Gets the latest change id.

Returns:

change id.

Throws:

ProvisioningException - in case of failure.

sync

List<WSChange> sync()
                    throws ProvisioningException

Returns changes to be synchronized.

Returns:

a set of changes

Throws:

ProvisioningException - in case of failure