org.connid.bundles.soap.provisioning.interfaces

Interface Provisioning

@BindingType(value="http://www.w3.org/2003/05/soap/bindings/HTTP/")
public interface Provisioning

Method Summary

Methods

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

Method Detail

isAuthenticationSupported

java.lang.Boolean isAuthenticationSupported()

Checks if authentication is supported.

Returns:

true if the resource support authentication.

isSyncSupported

java.lang.Boolean isSyncSupported()

Checks if synchronization is supported.

Returns:

true if the resource support synchronization.

authenticate

java.lang.String authenticate(java.lang.String username,
                            java.lang.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

java.lang.String checkAlive()

Returns "OK" if the resource is available.

Returns:

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

schema

java.util.List<WSAttribute> schema()

Returns the schema.

Returns:

a set of attributes.

create

java.lang.String create(java.util.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

java.lang.String update(java.lang.String accountid,
                      java.util.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

java.lang.String delete(java.lang.String accountid)
                        throws ProvisioningException

Deletes user account.

Parameters:

accountid. -

Returns:

accountid.

Throws:

ProvisioningException - in case of failure.

query

java.util.List<WSUser> query(Operand query)

Searches for user accounts.

Parameters:

query - filter

Returns:

a set of user accounts.

resolve

java.lang.String resolve(java.lang.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

java.util.List<WSChange> sync()
                              throws ProvisioningException

Returns changes to be synchronized.

Returns:

a set of changes

Throws:

ProvisioningException - in case of failure