DummyResource (midPoint Project 3.4.1 API)

java.lang.Object
- com.evolveum.icf.dummy.resource.DummyResource

All Implemented Interfaces:

DebugDumpable
```
public class DummyResource
extends Object
implements DebugDumpable
```
Resource for use with dummy ICF connector. This is a simple Java object that pretends to be a resource. It has accounts and account schema. It has operations to manipulate accounts, execute scripts and so on almost like a real resource. The purpose is to simulate a real resource with a very little overhead. The resource is a singleton, therefore the resource instance can be shared by the connector and the test code. The usual story is like this: 1) test class fetches first instance of the resource (getInstance). This will cause loading of the resource class in the test (parent) classloader. 2) test class configures the connector (e.g. schema) usually by calling the populateWithDefaultSchema() method. 3) test class initializes IDM. This will cause connector initialization. The connector will fetch the instance of dummy resource. As it was loaded by the parent classloader, it will get the same instance as the test class. 4) test class invokes IDM operation. That will invoke connector and change the resource. 5) test class will access resource directly to see if the operation went OK. The dummy resource is a separate package (JAR) from the dummy connector. Connector has its own classloader. If the resource would be the same package as connector, it will get loaded by the connector classloader regardless whether it is already loaded by the parent classloader.

Author:

Radovan Semancik

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ATTRIBUTE_CONNECTOR_CONFIGURATION_TO_STRING`
`static String`	`ATTRIBUTE_CONNECTOR_STATIC_VAL`
`static String`	`ATTRIBUTE_CONNECTOR_TO_STRING`

Fields inherited from interface com.evolveum.midpoint.util.DebugDumpable
INDENT_STRING

Method Summary

Methods
Modifier and Type	Method and Description
`String`	`addAccount(DummyAccount newAccount)`
`void`	`addAuxiliaryObjectClass(String name, DummyObjectClass objectClass)`
`String`	`addGroup(DummyGroup newGroup)`
`String`	`addOrg(DummyOrg newGroup)`
`String`	`addPrivilege(DummyPrivilege newGroup)`
`void`	`assertNoConnections()`
`void`	`changeDescriptionIfNeeded(DummyAccount account)`
`void`	`connect()`
`String`	`debugDump()` Show the content of the object intended for diagnostics by system administrator.
`String`	`debugDump(int indent)`
`void`	`deleteAccountById(String id)`
`void`	`deleteAccountByName(String id)`
`void`	`deleteGroupById(String id)`
`void`	`deleteGroupByName(String id)`
`void`	`deleteOrgById(String id)`
`void`	`deleteOrgByName(String id)`
`void`	`deletePrivilegeById(String id)`
`void`	`deletePrivilegeByName(String id)`
`void`	`disconnect()`
`DummyAccount`	`getAccountById(String id)`
`DummyAccount`	`getAccountByUsername(String username)`
`DummyObjectClass`	`getAccountObjectClass()`
`DummyObjectClass`	`getAccountObjectClassNoExceptions()`
`BreakMode`	`getAddBreakMode()`
`Map<String,DummyObjectClass>`	`getAuxiliaryObjectClassMap()`
`int`	`getConnectionCount()`
`BreakMode`	`getDeleteBreakMode()`
`List<DummyDelta>`	`getDeltasSince(int syncToken)`
`Collection<String>`	`getForbiddenNames()`
`BreakMode`	`getGetBreakMode()`
`DummyGroup`	`getGroupById(String id)`
`DummyGroup`	`getGroupByName(String name)`
`int`	`getGroupMembersReadCount()`
`DummyObjectClass`	`getGroupObjectClass()`
`static DummyResource`	`getInstance()`
`static DummyResource`	`getInstance(String instanceName)`
`String`	`getInstanceName()`
`int`	`getLatestSyncToken()`
`BreakMode`	`getModifyBreakMode()`
`DummyOrg`	`getOrgById(String id)`
`DummyOrg`	`getOrgByName(String name)`
`DummyPrivilege`	`getPrivilegeById(String id)`
`DummyPrivilege`	`getPrivilegeByName(String name)`
`DummyObjectClass`	`getPrivilegeObjectClass()`
`BreakMode`	`getSchemaBreakMode()`
`List<ScriptHistoryEntry>`	`getScriptHistory()` Returns script history ordered chronologically (oldest first).
`DummySyncStyle`	`getSyncStyle()`
`String`	`getUselessGuardedString()`
`String`	`getUselessString()`
`boolean`	`isBlockOperations()`
`boolean`	`isCaseIgnoreId()`
`boolean`	`isCaseIgnoreValues()`
`boolean`	`isEnforceSchema()`
`boolean`	`isEnforceUniqueName()`
`boolean`	`isGenerateAccountDescriptionOnCreate()`
`boolean`	`isGenerateAccountDescriptionOnUpdate()`
`boolean`	`isGenerateDefaultValues()`
`boolean`	`isTolerateDuplicateValues()`
`Collection<DummyAccount>`	`listAccounts()`
`Collection<DummyGroup>`	`listGroups()`
`Collection<DummyOrg>`	`listOrgs()`
`Collection<DummyPrivilege>`	`listPrivileges()`
`void`	`populateWithDefaultSchema()` Populates the resource with some kind of "default" schema.
`void`	`purgeScriptHistory()` Clears the script history.
`void`	`recordGroupMembersReadCount()`
`void`	`renameAccount(String id, String oldUsername, String newUsername)`
`void`	`renameGroup(String id, String oldName, String newName)`
`void`	`renameOrg(String id, String oldName, String newName)`
`void`	`renamePrivilege(String id, String oldName, String newName)`
`void`	`reset()` Clears everything, just like the resouce was just created.
`void`	`resetBreakMode()`
`void`	`runScript(String language, String scriptCode, Map<String,Object> params)` Pretend to run script on the resource.
`void`	`setAddBreakMode(BreakMode addBreakMode)`
`void`	`setBlockOperations(boolean blockOperations)`
`void`	`setBreakMode(BreakMode breakMode)`
`void`	`setCaseIgnoreId(boolean caseIgnoreId)`
`void`	`setCaseIgnoreValues(boolean caseIgnoreValues)`
`void`	`setDeleteBreakMode(BreakMode deleteBreakMode)`
`void`	`setEnforceSchema(boolean enforceSchema)`
`void`	`setEnforceUniqueName(boolean enforceUniqueName)`
`void`	`setForbiddenNames(Collection<String> forbiddenNames)`
`void`	`setGenerateAccountDescriptionOnCreate(boolean generateAccountDescriptionOnCreate)`
`void`	`setGenerateAccountDescriptionOnUpdate(boolean generateAccountDescriptionOnUpdate)`
`void`	`setGenerateDefaultValues(boolean generateDefaultValues)`
`void`	`setGetBreakMode(BreakMode getBreakMode)`
`void`	`setGroupMembersReadCount(int groupMembersReadCount)`
`void`	`setInstanceName(String instanceName)`
`void`	`setModifyBreakMode(BreakMode modifyBreakMode)`
`void`	`setSchemaBreakMode(BreakMode schemaBreakMode)`
`void`	`setSyncStyle(DummySyncStyle syncStyle)`
`void`	`setTolerateDuplicateValues(boolean tolerateDuplicateValues)`
`void`	`setUselessGuardedString(String uselessGuardedString)`
`void`	`setUselessString(String uselessString)`
`String`	`toString()`
`void`	`unblock()`
`void`	`unblockAll()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail
- ATTRIBUTE_CONNECTOR_TO_STRING
```
public static final String ATTRIBUTE_CONNECTOR_TO_STRING
```
  See Also:
  Constant Field Values
- ATTRIBUTE_CONNECTOR_STATIC_VAL
```
public static final String ATTRIBUTE_CONNECTOR_STATIC_VAL
```
  See Also:
  Constant Field Values
- ATTRIBUTE_CONNECTOR_CONFIGURATION_TO_STRING
```
public static final String ATTRIBUTE_CONNECTOR_CONFIGURATION_TO_STRING
```
  See Also:
  Constant Field Values

Method Detail

reset
```
public void reset()
```
Clears everything, just like the resouce was just created.

getInstance

public static DummyResource getInstance()

getInstance

public static DummyResource getInstance(String instanceName)

getInstanceName
```
public String getInstanceName()
```

setInstanceName

public void setInstanceName(String instanceName)

isTolerateDuplicateValues

public boolean isTolerateDuplicateValues()

setTolerateDuplicateValues

public void setTolerateDuplicateValues(boolean tolerateDuplicateValues)

isGenerateDefaultValues

public boolean isGenerateDefaultValues()

setGenerateDefaultValues

public void setGenerateDefaultValues(boolean generateDefaultValues)

isEnforceUniqueName
```
public boolean isEnforceUniqueName()
```

setEnforceUniqueName

public void setEnforceUniqueName(boolean enforceUniqueName)

isEnforceSchema
```
public boolean isEnforceSchema()
```

setEnforceSchema

public void setEnforceSchema(boolean enforceSchema)

getSchemaBreakMode
```
public BreakMode getSchemaBreakMode()
```

setSchemaBreakMode

public void setSchemaBreakMode(BreakMode schemaBreakMode)

getAddBreakMode
```
public BreakMode getAddBreakMode()
```

setAddBreakMode

public void setAddBreakMode(BreakMode addBreakMode)

getGetBreakMode
```
public BreakMode getGetBreakMode()
```

setGetBreakMode

public void setGetBreakMode(BreakMode getBreakMode)

getModifyBreakMode
```
public BreakMode getModifyBreakMode()
```

setModifyBreakMode

public void setModifyBreakMode(BreakMode modifyBreakMode)

getDeleteBreakMode
```
public BreakMode getDeleteBreakMode()
```

setDeleteBreakMode

public void setDeleteBreakMode(BreakMode deleteBreakMode)

setBreakMode

public void setBreakMode(BreakMode breakMode)

resetBreakMode
```
public void resetBreakMode()
```

isBlockOperations
```
public boolean isBlockOperations()
```

setBlockOperations

public void setBlockOperations(boolean blockOperations)

getUselessString
```
public String getUselessString()
```

setUselessString

public void setUselessString(String uselessString)

getUselessGuardedString

public String getUselessGuardedString()

setUselessGuardedString

public void setUselessGuardedString(String uselessGuardedString)

isCaseIgnoreId
```
public boolean isCaseIgnoreId()
```

setCaseIgnoreId

public void setCaseIgnoreId(boolean caseIgnoreId)

isCaseIgnoreValues
```
public boolean isCaseIgnoreValues()
```

setCaseIgnoreValues

public void setCaseIgnoreValues(boolean caseIgnoreValues)

isGenerateAccountDescriptionOnCreate

public boolean isGenerateAccountDescriptionOnCreate()

setGenerateAccountDescriptionOnCreate

public void setGenerateAccountDescriptionOnCreate(boolean generateAccountDescriptionOnCreate)

isGenerateAccountDescriptionOnUpdate

public boolean isGenerateAccountDescriptionOnUpdate()

setGenerateAccountDescriptionOnUpdate

public void setGenerateAccountDescriptionOnUpdate(boolean generateAccountDescriptionOnUpdate)

getForbiddenNames

public Collection<String> getForbiddenNames()

setForbiddenNames

public void setForbiddenNames(Collection<String> forbiddenNames)

getConnectionCount
```
public int getConnectionCount()
```

connect
```
public void connect()
```

disconnect
```
public void disconnect()
```

assertNoConnections
```
public void assertNoConnections()
```

getGroupMembersReadCount
```
public int getGroupMembersReadCount()
```

setGroupMembersReadCount

public void setGroupMembersReadCount(int groupMembersReadCount)

recordGroupMembersReadCount

public void recordGroupMembersReadCount()

getAccountObjectClass

public DummyObjectClass getAccountObjectClass()
                                       throws ConnectException,
                                              FileNotFoundException,
                                              SchemaViolationException

Throws:: ConnectException; FileNotFoundException; SchemaViolationException

getAccountObjectClassNoExceptions

public DummyObjectClass getAccountObjectClassNoExceptions()

getGroupObjectClass

public DummyObjectClass getGroupObjectClass()

getPrivilegeObjectClass

public DummyObjectClass getPrivilegeObjectClass()

getAuxiliaryObjectClassMap

public Map<String,DummyObjectClass> getAuxiliaryObjectClassMap()

addAuxiliaryObjectClass

public void addAuxiliaryObjectClass(String name,
                           DummyObjectClass objectClass)

listAccounts

public Collection<DummyAccount> listAccounts()
                                      throws ConnectException,
                                             FileNotFoundException,
                                             SchemaViolationException

Throws:: ConnectException; FileNotFoundException; SchemaViolationException

getAccountByUsername

public DummyAccount getAccountByUsername(String username)
                                  throws ConnectException,
                                         FileNotFoundException,
                                         SchemaViolationException

Throws:: ConnectException; FileNotFoundException; SchemaViolationException

getGroupByName

public DummyGroup getGroupByName(String name)
                          throws ConnectException,
                                 FileNotFoundException,
                                 SchemaViolationException

Throws:: ConnectException; FileNotFoundException; SchemaViolationException

getPrivilegeByName

public DummyPrivilege getPrivilegeByName(String name)
                                  throws ConnectException,
                                         FileNotFoundException,
                                         SchemaViolationException

Throws:: ConnectException; FileNotFoundException; SchemaViolationException

getOrgByName

public DummyOrg getOrgByName(String name)
                      throws ConnectException,
                             FileNotFoundException,
                             SchemaViolationException

Throws:: ConnectException; FileNotFoundException; SchemaViolationException

getAccountById

public DummyAccount getAccountById(String id)
                            throws ConnectException,
                                   FileNotFoundException,
                                   SchemaViolationException

Throws:: ConnectException; FileNotFoundException; SchemaViolationException

getGroupById

public DummyGroup getGroupById(String id)
                        throws ConnectException,
                               FileNotFoundException,
                               SchemaViolationException

Throws:: ConnectException; FileNotFoundException; SchemaViolationException

getPrivilegeById

public DummyPrivilege getPrivilegeById(String id)
                                throws ConnectException,
                                       FileNotFoundException,
                                       SchemaViolationException

Throws:: ConnectException; FileNotFoundException; SchemaViolationException

getOrgById

public DummyOrg getOrgById(String id)
                    throws ConnectException,
                           FileNotFoundException,
                           SchemaViolationException

Throws:: ConnectException; FileNotFoundException; SchemaViolationException

listGroups

public Collection<DummyGroup> listGroups()
                                  throws ConnectException,
                                         FileNotFoundException,
                                         SchemaViolationException

Throws:: ConnectException; FileNotFoundException; SchemaViolationException

listPrivileges

public Collection<DummyPrivilege> listPrivileges()
                                          throws ConnectException,
                                                 FileNotFoundException,
                                                 SchemaViolationException

Throws:: ConnectException; FileNotFoundException; SchemaViolationException

listOrgs

public Collection<DummyOrg> listOrgs()
                              throws ConnectException,
                                     FileNotFoundException,
                                     SchemaViolationException

Throws:: ConnectException; FileNotFoundException; SchemaViolationException

deleteAccountById

public void deleteAccountById(String id)
                       throws ConnectException,
                              FileNotFoundException,
                              ObjectDoesNotExistException,
                              SchemaViolationException

Throws:: ConnectException; FileNotFoundException; ObjectDoesNotExistException; SchemaViolationException

deleteGroupById

public void deleteGroupById(String id)
                     throws ConnectException,
                            FileNotFoundException,
                            ObjectDoesNotExistException,
                            SchemaViolationException

Throws:: ConnectException; FileNotFoundException; ObjectDoesNotExistException; SchemaViolationException

deletePrivilegeById

public void deletePrivilegeById(String id)
                         throws ConnectException,
                                FileNotFoundException,
                                ObjectDoesNotExistException,
                                SchemaViolationException

Throws:: ConnectException; FileNotFoundException; ObjectDoesNotExistException; SchemaViolationException

deleteOrgById

public void deleteOrgById(String id)
                   throws ConnectException,
                          FileNotFoundException,
                          ObjectDoesNotExistException,
                          SchemaViolationException

Throws:: ConnectException; FileNotFoundException; ObjectDoesNotExistException; SchemaViolationException

addAccount

public String addAccount(DummyAccount newAccount)
                  throws ObjectAlreadyExistsException,
                         ConnectException,
                         FileNotFoundException,
                         SchemaViolationException

Throws:: ObjectAlreadyExistsException; ConnectException; FileNotFoundException; SchemaViolationException

deleteAccountByName

public void deleteAccountByName(String id)
                         throws ObjectDoesNotExistException,
                                ConnectException,
                                FileNotFoundException,
                                SchemaViolationException

Throws:: ObjectDoesNotExistException; ConnectException; FileNotFoundException; SchemaViolationException

renameAccount

public void renameAccount(String id,
                 String oldUsername,
                 String newUsername)
                   throws ObjectDoesNotExistException,
                          ObjectAlreadyExistsException,
                          ConnectException,
                          FileNotFoundException,
                          SchemaViolationException,
                          SchemaViolationException

Throws:: ObjectDoesNotExistException; ObjectAlreadyExistsException; ConnectException; FileNotFoundException; SchemaViolationException

changeDescriptionIfNeeded

public void changeDescriptionIfNeeded(DummyAccount account)
                               throws SchemaViolationException

Throws:: SchemaViolationException

addGroup

public String addGroup(DummyGroup newGroup)
                throws ObjectAlreadyExistsException,
                       ConnectException,
                       FileNotFoundException,
                       SchemaViolationException,
                       SchemaViolationException

Throws:: ObjectAlreadyExistsException; ConnectException; FileNotFoundException; SchemaViolationException

deleteGroupByName

public void deleteGroupByName(String id)
                       throws ObjectDoesNotExistException,
                              ConnectException,
                              FileNotFoundException,
                              SchemaViolationException

Throws:: ObjectDoesNotExistException; ConnectException; FileNotFoundException; SchemaViolationException

renameGroup

public void renameGroup(String id,
               String oldName,
               String newName)
                 throws ObjectDoesNotExistException,
                        ObjectAlreadyExistsException,
                        ConnectException,
                        FileNotFoundException,
                        SchemaViolationException

Throws:: ObjectDoesNotExistException; ObjectAlreadyExistsException; ConnectException; FileNotFoundException; SchemaViolationException

addPrivilege

public String addPrivilege(DummyPrivilege newGroup)
                    throws ObjectAlreadyExistsException,
                           ConnectException,
                           FileNotFoundException,
                           SchemaViolationException,
                           SchemaViolationException

Throws:: ObjectAlreadyExistsException; ConnectException; FileNotFoundException; SchemaViolationException

deletePrivilegeByName

public void deletePrivilegeByName(String id)
                           throws ObjectDoesNotExistException,
                                  ConnectException,
                                  FileNotFoundException,
                                  SchemaViolationException

Throws:: ObjectDoesNotExistException; ConnectException; FileNotFoundException; SchemaViolationException

renamePrivilege

public void renamePrivilege(String id,
                   String oldName,
                   String newName)
                     throws ObjectDoesNotExistException,
                            ObjectAlreadyExistsException,
                            ConnectException,
                            FileNotFoundException,
                            SchemaViolationException

Throws:: ObjectDoesNotExistException; ObjectAlreadyExistsException; ConnectException; FileNotFoundException; SchemaViolationException

addOrg

public String addOrg(DummyOrg newGroup)
              throws ObjectAlreadyExistsException,
                     ConnectException,
                     FileNotFoundException,
                     SchemaViolationException,
                     SchemaViolationException

Throws:: ObjectAlreadyExistsException; ConnectException; FileNotFoundException; SchemaViolationException

deleteOrgByName

public void deleteOrgByName(String id)
                     throws ObjectDoesNotExistException,
                            ConnectException,
                            FileNotFoundException,
                            SchemaViolationException

Throws:: ObjectDoesNotExistException; ConnectException; FileNotFoundException; SchemaViolationException

renameOrg

public void renameOrg(String id,
             String oldName,
             String newName)
               throws ObjectDoesNotExistException,
                      ObjectAlreadyExistsException,
                      ConnectException,
                      FileNotFoundException,
                      SchemaViolationException

Throws:: ObjectDoesNotExistException; ObjectAlreadyExistsException; ConnectException; FileNotFoundException; SchemaViolationException

getScriptHistory
```
public List<ScriptHistoryEntry> getScriptHistory()
```
Returns script history ordered chronologically (oldest first).

Returns:
script history

purgeScriptHistory
```
public void purgeScriptHistory()
```
Clears the script history.

runScript
```
public void runScript(String language,
             String scriptCode,
             Map<String,Object> params)
```
Pretend to run script on the resource. The script is actually not executed, it is only recorded in the script history and can be fetched by getScriptHistory().

Parameters:
scriptCode - code of the script

populateWithDefaultSchema
```
public void populateWithDefaultSchema()
```
Populates the resource with some kind of "default" schema. This is a schema that should suit majority of basic test cases.

getSyncStyle
```
public DummySyncStyle getSyncStyle()
```

setSyncStyle

public void setSyncStyle(DummySyncStyle syncStyle)

getLatestSyncToken
```
public int getLatestSyncToken()
```

getDeltasSince

public List<DummyDelta> getDeltasSince(int syncToken)

unblock
```
public void unblock()
```

unblockAll
```
public void unblockAll()
```

debugDump
```
public String debugDump()
```
Description copied from interface: DebugDumpable

Show the content of the object intended for diagnostics by system administrator. The out put should be suitable to use in system logs at "debug" level. It may be multi-line, but in that case it should be well indented and quite terse. As it is intended to be used by system administrator, it should not use any developer terms such as class names, exceptions or stack traces.

Specified by:

debugDump in interface DebugDumpable

Returns:
content of the object intended for diagnostics by system administrator.

debugDump
```
public String debugDump(int indent)
```
Specified by:

debugDump in interface DebugDumpable

toString
```
public String toString()
```
Overrides:

toString in class Object

Class DummyResource

Field Summary

Fields inherited from interface com.evolveum.midpoint.util.DebugDumpable

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ATTRIBUTE_CONNECTOR_TO_STRING

ATTRIBUTE_CONNECTOR_STATIC_VAL

ATTRIBUTE_CONNECTOR_CONFIGURATION_TO_STRING

Method Detail

reset

getInstance

getInstance

getInstanceName

setInstanceName

isTolerateDuplicateValues

setTolerateDuplicateValues

isGenerateDefaultValues

setGenerateDefaultValues

isEnforceUniqueName

setEnforceUniqueName

isEnforceSchema

setEnforceSchema

getSchemaBreakMode

setSchemaBreakMode

getAddBreakMode

setAddBreakMode

getGetBreakMode

setGetBreakMode

getModifyBreakMode

setModifyBreakMode

getDeleteBreakMode

setDeleteBreakMode

setBreakMode

resetBreakMode

isBlockOperations

setBlockOperations

getUselessString

setUselessString

getUselessGuardedString

setUselessGuardedString

isCaseIgnoreId

setCaseIgnoreId

isCaseIgnoreValues

setCaseIgnoreValues

isGenerateAccountDescriptionOnCreate

setGenerateAccountDescriptionOnCreate

isGenerateAccountDescriptionOnUpdate

setGenerateAccountDescriptionOnUpdate

getForbiddenNames

setForbiddenNames

getConnectionCount

connect

disconnect

assertNoConnections

getGroupMembersReadCount

setGroupMembersReadCount

recordGroupMembersReadCount

getAccountObjectClass

getAccountObjectClassNoExceptions

getGroupObjectClass

getPrivilegeObjectClass

getAuxiliaryObjectClassMap

addAuxiliaryObjectClass

listAccounts

getAccountByUsername

getGroupByName

getPrivilegeByName

getOrgByName

getAccountById

getGroupById

getPrivilegeById

getOrgById

listGroups

listPrivileges

listOrgs

deleteAccountById

deleteGroupById

deletePrivilegeById

deleteOrgById