package org.forgerock.openicf.common.protobuf

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: ConnectorInfo

• int32 order = 1

• bool connectorPoolingSupported = 2

• optional ObjectPoolConfiguration connectorPoolConfiguration = 3

• optional ResultsHandlerConfiguration resultsHandlerConfiguration = 4

• repeated ConfigurationProperty configurationProperties = 5

• repeated TimeoutMapFieldEntry timeoutMap = 6

• repeated APIOperation supportedOperations = 7

• int32 producerBufferSize = 8

Used in: APIConfiguration, SupportedMapFieldEntry, TimeoutMapFieldEntry

• UNKNOWNAPIOP = 0

• AUTHENTICATIONAPIOP = 1

• CREATEAPIOP = 2

• DELETEAPIOP = 3

• GETAPIOP = 4

• RESOLVEUSERNAMEAPIOP = 5

• SCHEMAAPIOP = 6

• SCRIPTONCONNECTORAPIOP = 7

• SCRIPTONRESOURCEAPIOP = 8

• SEARCHAPIOP = 9

• SYNCAPIOP = 10

• TESTAPIOP = 11

• UPDATEAPIOP = 12

• VALIDATEAPIOP = 13

CompositeFilter

Used in: FilterUnionMessage

• repeated FilterUnionMessage subFilters = 1

Used in: AttributeMapFieldEntry, ContainsAllValuesFilter, EqualsFilter

• bool caseInsensitive = 1

• repeated AttributeUnionValue attribute = 2

Used in: ObjectClassInfo

• string name = 1

• AttributeInfo.AttributeType type = 2

• repeated AttributeInfo.Flags flags = 3

Used in: AttributeInfo

• STRING = 0

• LONG = 1

• CHARACTER = 2

• DOUBLE = 3

• FLOAT = 4

• INTEGER = 5

• BOOLEAN = 6

• BYTE = 7

• BYTEARRAY = 8

• BIGDECIMAL = 9

• BIGINTEGER = 10

• MAP = 11

Used in: AttributeInfo

• NONE = 0

• REQUIRED = 1

• MULTIVALUED = 2

• NOT_CREATABLE = 3

• NOT_UPDATEABLE = 4

• NOT_READABLE = 5

• NOT_RETURNED_BY_DEFAULT = 6

Used in: AttributeMapValue

• string key = 1

  option map_entry = true;

• oneof value

  • AttributeUnionValue attribute = 2

  • AttributeCollectionValue collectionAttribute = 3

Used in: AttributeUnionValue

• bool caseInsensitive = 1

• repeated AttributeMapFieldEntry value = 2

• string name = 1

  option map_entry = true;

• repeated AttributeUnionValue value = 2

Used in: AttributeCollectionValue, AttributeMapFieldEntry, AttributeMessage, GreaterThanFilter, GreaterThanOrEqualFilter, LessThanFilter, LessThanOrEqualFilter, SyncTokenTest

• oneof payload

  • string stringValue = 1

  • int64 longValue = 2

  • string characterValue = 3

  • double doubleValue = 4

  • float floatValue = 5

  • int32 integerValue = 6

  • bool booleanValue = 7

  • bytes byteValue = 8

  • bytes byteArrayValue = 9

  • BigDecimal bigDecimalValue = 10

  • string bigIntegerValue = 11

  • bytes guardedByteArrayValue = 12

  • bytes guardedStringValue = 13

  • AttributeMapValue mapValue = 14

Interface AuthenticateOp

Used in: OperationRequest

• string objectClass = 1

• string username = 2

• bytes password = 3

• bytes options = 4

Used in: OperationResponse

• optional Uid uid = 1

Used in: BatchOpResult

• string resultMessage = 2

Interface BatchOp

Used in: OperationRequest

• bool query = 1

• repeated BatchOpTask tasks = 2

• repeated string batchToken = 3

• bytes options = 4

Used in: OperationResponse

• repeated string batchToken = 1

• string taskId = 2

• bool complete = 3

• bool error = 4

• bool queryRequired = 5

• bool asynchronousResults = 6

• bool returnsResults = 7

• optional Uid uid = 8

• optional BatchEmptyResponse emptyResult = 9

Used in: BatchOpRequest

• string taskId = 1

• optional CreateOpRequest createRequest = 2

• optional DeleteOpRequest deleteRequest = 3

• optional UpdateOpRequest updateRequest = 4

Used in: AttributeUnionValue

• string unscaled = 1

• int32 scale = 2

Used in: RPCRequest

(message has no fields)

Used in: ConnectorMessages

• optional Locale key = 1

  option map_entry = true;

• repeated StringMapFieldEntry value = 2

Configuration Update Event

Used in: OperationRequest

• bytes configurationPropertyChange = 1

• bool caseInsensitive = 1

• repeated ConfigurationUnionValue configuration = 2

Used in: APIConfiguration

• int32 order = 1

• bool required = 2

• bool confidential = 3

• string name = 4

• string helpMessageKey = 5

• string displayMessageKey = 6

• string groupMessageKey = 7

• string type = 8

• string value = 9

• repeated SPIOperation operations = 10

Used in: ConfigurationCollectionValue

• oneof payload

  • string stringValue = 1

  • int64 longValue = 2

  • string characterValue = 3

  • double doubleValue = 4

  • float floatValue = 5

  • int32 integerValue = 6

  • bool booleanValue = 7

  • string uriValue = 8

  • string fileValue = 9

  • bytes guardedByteArrayValue = 10

  • bytes guardedStringValue = 11

  • Script scriptValue = 12

Interface ConnectorEventSubscriptionOp

Used in: OperationRequest

• string objectClass = 1

• bytes eventFilter = 2

• bytes options = 3

Used in: OperationResponse

• optional ConnectorObject connectorObject = 1

• bool completed = 2

• string connectorDisplayNameKey = 1

• string connectorCategoryKey = 2

• optional ConnectorKey connectorKey = 3

• optional ConnectorMessages connectorMessages = 4

• optional APIConfiguration APIConfiguration = 5

Used in: ConnectorInfo, OperationRequest

• string bundleName = 1

• string bundleVersion = 2

• string connectorName = 3

Used in: ConnectorInfo

• repeated CatalogMapFieldEntry catalogs = 1

  Map<Locale, Map<String, String>>

Used in: ConnectorEventSubscriptionOpResponse, SearchOpResponse

• string objectClass = 1

  message MapFieldEntry { //option map_entry = true; string key = 1; AttributeCollectionValue value = 2; }

• bytes attributes = 2

  repeated MapFieldEntry map_field = 2;

AttributeFilter

Used in: FilterUnionMessage

• string name = 1

• optional AttributeCollectionValue value = 2

Used in: FilterUnionMessage

• string name = 1

• string value = 2

Used in: RPCRequest

• repeated ControlRequest.InfoLevel infoLevel = 1

• repeated int64 localRequestId = 2

• repeated int64 remoteRequestId = 3

Used in: ControlRequest

• CONNECTOR_INFO = 0

• CONTEXT_INFO = 1

• REQUESTS = 2

Used in: RPCResponse

• repeated ControlResponse.StringMapFieldEntry contextInfoMap = 1

• bytes connectorInfos = 2

• repeated int64 requestIds = 3

Used in: ControlResponse

• string key = 1

  option map_entry = true;

• string value = 2

Interface CreateOp

Used in: BatchOpTask, OperationRequest

• string objectClass = 1

• bytes createAttributes = 2

• bytes options = 3

  repeated AttributeMessage createAttributes = 2;

Used in: OperationResponse

• optional Uid uid = 1

Interface DeleteOp

Used in: BatchOpTask, OperationRequest

• string objectClass = 1

• optional Uid uid = 2

• bytes options = 3

Used in: OperationResponse

(message has no fields)

Used in: FilterUnionMessage

• string name = 1

• string value = 2

Used in: FilterUnionMessage

• string name = 1

• optional AttributeCollectionValue value = 2

Used in: RPCResponse

• string exceptionClass = 1

• string message = 2

• optional ExceptionMessage.InnerCause innerCause = 3

• string stackTrace = 4

Used in: ExceptionMessage

• string exceptionClass = 1

• string message = 2

• optional InnerCause cause = 3

Used in: AndFilter, NotFilter, OrFilter

• oneof filter

  • AndFilter andFilter = 1

  • OrFilter orFilter = 2

  • NotFilter notFilter = 3

  • ContainsAllValuesFilter containsAllValuesFilter = 4

  • EqualsFilter equalsFilter = 5

  • StartsWithFilter startsWithFilter = 6

  • ContainsFilter containsFilter = 7

  • EndsWithFilter endsWithFilter = 8

  • GreaterThanFilter greaterThanFilter = 9

  • GreaterThanOrEqualFilter greaterThanOrEqualFilter = 10

  • LessThanFilter lessThanFilter = 11

  • LessThanOrEqualFilter lessThanOrEqualFilter = 12

Interface GetOp

Used in: OperationRequest

• string objectClass = 1

• optional Uid uid = 2

• bytes options = 3

Used in: OperationResponse

• bytes connectorObject = 1

ComparableAttributeFilter

Used in: FilterUnionMessage

• string name = 1

• optional AttributeUnionValue value = 2

Used in: FilterUnionMessage

• string name = 1

• optional AttributeUnionValue value = 2

Handshake Message

Used in: RPCRequest, RPCResponse

• string sessionId = 1

• HandshakeMessage.ServerType serverType = 2

• bytes publicKey = 3

Used in: HandshakeMessage

• UNKNOWN = 0

• JAVA = 1

• DOTNET = 2

Used in: FilterUnionMessage

• string name = 1

• optional AttributeUnionValue value = 2

Used in: FilterUnionMessage

• string name = 1

• optional AttributeUnionValue value = 2

Used in: CatalogMapFieldEntry, OperationRequest

• string language = 1

• string country = 2

• string variant = 3

Used in: FilterUnionMessage

• optional FilterUnionMessage subFilter = 1

• string type = 1

• optional AttributeInfo attributeInfos = 2

• bool isContainer = 3

Used in: APIConfiguration

• int32 maxObjects = 1

• int32 maxIdle = 2

• int64 maxWait = 3

• int64 minEvictableIdleTimeMillis = 4

• int32 minIdle = 5

• string name = 1

• OperationOptionInfo.OperationOptionType type = 2

• bool isArray = 3

Used in: OperationOptionInfo

• STRING = 0

• LONG = 1

• CHARACTER = 2

• DOUBLE = 3

• FLOAT = 4

• INTEGER = 5

• BOOLEAN = 6

• URI = 7

• FILE = 8

• GUARDEDBYTEARRAY = 9

• GUARDEDSTRING = 10

• SCRIPT = 11

• OBJECTCLASS = 12

• UID = 13

• QUALIFIEDUID = 14

• SORTKEY = 15

• string key = 1

  option map_entry = true;

• repeated OperationOptionUnionValue values = 2

• bool isArray = 3

Used in: OperationOptionMapFieldEntry

• oneof payload

  • string stringValue = 1

  • int64 longValue = 2

  • string characterValue = 3

  • double doubleValue = 4

  • float floatValue = 5

  • int32 integerValue = 6

  • bool booleanValue = 7

  • string uriValue = 8

  • string fileValue = 9

  • bytes guardedByteArrayValue = 10

  • bytes guardedStringValue = 11

  • Script scriptValue = 12

  • string objectClassValue = 13

  • Uid uidValue = 14

  • QualifiedUid qualifiedUidValue = 15

  • SortKey sortKeyValue = 16

Used in: RPCRequest

• optional ConnectorKey connectorKey = 1

• bytes connectorFacadeKey = 2

• optional Locale locale = 3

• optional AuthenticateOpRequest authenticateOpRequest = 4

  oneof request {

• optional CreateOpRequest createOpRequest = 5

• optional ConnectorEventSubscriptionOpRequest connectorEventSubscriptionOpRequest = 6

• optional DeleteOpRequest deleteOpRequest = 7

• optional GetOpRequest getOpRequest = 8

• optional ResolveUsernameOpRequest resolveUsernameOpRequest = 9

• optional SchemaOpRequest schemaOpRequest = 10

• optional ScriptOnConnectorOpRequest scriptOnConnectorOpRequest = 11

• optional ScriptOnResourceOpRequest scriptOnResourceOpRequest = 12

• optional SearchOpRequest searchOpRequest = 13

• optional SyncOpRequest syncOpRequest = 14

• optional SyncEventSubscriptionOpRequest syncEventSubscriptionOpRequest = 15

• optional TestOpRequest testOpRequest = 16

• optional UpdateOpRequest updateOpRequest = 17

• optional ValidateOpRequest ValidateOpRequest = 18

• optional ConfigurationChangeEvent configurationChangeEvent = 19

• optional BatchOpRequest batchOpRequest = 20

  }

Used in: RPCResponse

• optional AuthenticateOpResponse authenticateOpResponse = 1

  oneof response {

• optional CreateOpResponse createOpResponse = 2

• optional ConnectorEventSubscriptionOpResponse connectorEventSubscriptionOpResponse = 3

• optional DeleteOpResponse deleteOpResponse = 4

• optional GetOpResponse GetOpResponse = 5

• optional ResolveUsernameOpResponse resolveUsernameOpResponse = 6

• optional SchemaOpResponse schemaOpResponse = 7

• optional ScriptOnConnectorOpResponse scriptOnConnectorOpResponse = 8

• optional ScriptOnResourceOpResponse scriptOnResourceOpResponse = 9

• optional SearchOpResponse searchOpResponse = 10

• optional SyncOpResponse syncOpResponse = 11

• optional SyncEventSubscriptionOpResponse syncEventSubscriptionOpResponse = 12

• optional TestOpResponse testOpResponse = 13

• optional UpdateOpResponse updateOpResponse = 14

• optional ValidateOpResponse validateOpResponse = 15

• optional BatchOpResult batchOpResult = 16

  }

Used in: FilterUnionMessage

• repeated FilterUnionMessage subFilters = 1

Maximum 125 byte

(message has no fields)

• string name = 1

Used in: OperationOptionUnionValue

• string objectClass = 1

• optional Uid uid = 2

Used in: RemoteMessage

• optional HandshakeMessage handshakeMessage = 1

  oneof request {

• optional ControlRequest controlRequest = 2

• optional OperationRequest operationRequest = 3

• optional CancelOpRequest cancelOpRequest = 4

  }

Used in: RemoteMessage

• optional HandshakeMessage handshakeMessage = 1

  oneof response {

• optional ControlResponse controlResponse = 2

• optional OperationResponse operationResponse = 3

• optional ExceptionMessage error = 4

  }

• int64 messageId = 1

• optional RPCRequest request = 2

  oneof message {

• optional RPCResponse response = 3

  }

Interface ResolveUsernameOp

Used in: OperationRequest

• string objectClass = 1

• string username = 2

• bytes options = 3

Used in: OperationResponse

• optional Uid uid = 1

Used in: APIConfiguration

• bool enableNormalizingResultsHandler = 1

• bool enableFilteredResultsHandler = 2

• bool enableCaseInsensitiveFilter = 3

• bool enableAttributesToGetSearchResultsHandler = 4

Used in: ConfigurationProperty

• UNKNOWNOP = 0

• AUTHENTICATIONOP = 1

• CREATEOP = 2

• DELETEOP = 3

• RESOLVEUSERNAMEOP = 4

• SCHEMAOP = 5

• SCRIPTONCONNECTOROP = 6

• SCRIPTONRESOURCEOP = 7

• SEARCHOP = 8

• SYNCOP = 9

• TESTOP = 10

• UPDATEATTRIBUTEVALUESOP = 11

• UPDATEOP = 12

• repeated string declaredObjectClasses = 1

• repeated string declaredOperationOptions = 2

• repeated SupportedMapFieldEntry supportedObjectClassesByOperation = 3

• repeated SupportedMapFieldEntry supportedOptionsByOperation = 4

Interface SchemaOp

Used in: OperationRequest

(message has no fields)

Used in: OperationResponse

• bytes schema = 1

Used in: ConfigurationUnionValue, OperationOptionUnionValue, ScriptContext

• string scriptLanguage = 1

• string scriptText = 2

Used in: ScriptOnConnectorOpRequest, ScriptOnResourceOpRequest

• optional Script script = 1

• bytes scriptArguments = 2

Interface ScriptOnConnectorOp

Used in: OperationRequest

• optional ScriptContext scriptContext = 1

• bytes options = 2

Used in: OperationResponse

• bytes object = 1

Interface ScriptOnResourceOp

Used in: OperationRequest

• optional ScriptContext scriptContext = 1

• bytes options = 2

Used in: OperationResponse

• bytes object = 1

Interface SearchOp

Used in: OperationRequest

• string objectClass = 1

• bytes filter = 2

• bytes options = 3

  FilterUnionMessage filter = 2;

Used in: OperationResponse

• int64 sequence = 1

• optional SearchResult result = 2

• optional ConnectorObject connectorObject = 3

Used in: SearchOpResponse

• string pagedResultsCookie = 1

• SearchResult.CountPolicy totalPagedResultsPolicy = 2

• int32 totalPagedResults = 3

• int32 remainingPagedResults = 4

Used in: SearchResult

• NONE = 0

• ESTIMATE = 1

• EXACT = 2

Used in: OperationOptionUnionValue

• string field = 1

• bool isAscending = 2

StringFilter

Used in: FilterUnionMessage

• string name = 1

• string value = 2

Used in: CatalogMapFieldEntry

• string key = 1

  option map_entry = true;

• string value = 2

Used in: Schema

• APIOperation key = 1

• string name = 2

Used in: SyncEventSubscriptionOpResponse, SyncOpResponse.Sync

• optional SyncToken token = 1

• SyncDelta.SyncDeltaType deltaType = 2

• optional Uid previousUid = 3

• string objectClass = 4

• optional Uid uid = 5

• bytes connectorObject = 6

Used in: SyncDelta

• CREATE_OR_UPDATE = 0

• DELETE = 1

• CREATE = 2

• UPDATE = 3

Interface SyncEventSubscriptionOp

Used in: OperationRequest

• string objectClass = 1

• optional SyncToken token = 2

• bytes options = 3

Used in: OperationResponse

• optional SyncDelta syncDelta = 1

• bool completed = 2

Interface SyncOp

Used in: OperationRequest

• optional SyncOpRequest.Sync sync = 1

• optional SyncOpRequest.LatestSyncToken latestSyncToken = 2

Used in: SyncOpRequest

• string objectClass = 1

Used in: SyncOpRequest

• string objectClass = 1

• optional SyncToken token = 2

• bytes options = 3

Used in: OperationResponse

• optional SyncOpResponse.Sync sync = 1

• optional SyncOpResponse.LatestSyncToken latestSyncToken = 2

Used in: SyncOpResponse

• optional SyncToken syncToken = 1

Used in: SyncOpResponse

• int64 sequence = 1

• optional SyncToken syncToken = 2

• optional SyncDelta syncDelta = 3

Used in: SyncDelta, SyncEventSubscriptionOpRequest, SyncOpRequest.Sync, SyncOpResponse.LatestSyncToken, SyncOpResponse.Sync

• bytes value = 1

• optional AttributeUnionValue value = 1

Interface TestOp

Used in: OperationRequest

(message has no fields)

Used in: OperationResponse

(message has no fields)

Used in: APIConfiguration

• APIOperation key = 1

  option map_entry = true;

• int32 value = 2

Used in: AuthenticateOpResponse, BatchOpResult, CreateOpResponse, DeleteOpRequest, GetOpRequest, OperationOptionUnionValue, QualifiedUid, ResolveUsernameOpResponse, SyncDelta, UpdateOpRequest, UpdateOpResponse

• string value = 1

• string revision = 2

Interface UpdateOp

Used in: BatchOpTask, OperationRequest

• string objectClass = 1

• optional Uid uid = 2

• UpdateOpRequest.UpdateType updateType = 3

• bytes replaceAttributes = 4

• bytes options = 5

  repeated AttributeMessage replaceAttributes = 4;

Used in: UpdateOpRequest

• REPLACE = 0

• ADD = 1

• REMOVE = 2

Used in: OperationResponse

• optional Uid uid = 1

Interface ValidateApiOp

Used in: OperationRequest

(message has no fields)

Used in: OperationResponse

(message has no fields)