org.identityconnectors.framework.common.objects.Schema Maven / Gradle / Ivy
The newest version!
/*
* ====================
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
*
* Copyright 2008-2009 Sun Microsystems, Inc. All rights reserved.
*
* The contents of this file are subject to the terms of the Common Development
* and Distribution License("CDDL") (the "License"). You may not use this file
* except in compliance with the License.
*
* You can obtain a copy of the License at
* http://IdentityConnectors.dev.java.net/legal/license.txt
* See the License for the specific language governing permissions and limitations
* under the License.
*
* When distributing the Covered Code, include this CDDL Header Notice in each file
* and include the License file at identityconnectors/legal/license.txt.
* If applicable, add the following below this CDDL Header, with the fields
* enclosed by brackets [] replaced by your own identifying information:
* "Portions Copyrighted [year] [name of copyright owner]"
* ====================
*/
package org.identityconnectors.framework.common.objects;
import java.util.Collections;
import java.util.HashMap;
import java.util.Set;
import java.util.Map;
import org.identityconnectors.common.Assertions;
import org.identityconnectors.common.CollectionUtil;
import org.identityconnectors.framework.api.operations.APIOperation;
import org.identityconnectors.framework.common.serializer.SerializerUtil;
/**
* Determines the objects supported by a
* {@link org.identityconnectors.framework.spi.Connector}.
* The {@link Schema} object is used to represent the basic objects that a
* connector supports. This does not prevent a connector from supporting more.
* Rather, this is informational for the caller of the connector to understand
* a minimum support level.
* The schema defines 4 primary data structures
*
* - Declared ObjectClasses ({@link #getObjectClassInfo()}).
* - Declared OperationOptionInfo ({@link #getOperationOptionInfo()}).
* - Supported ObjectClasses by operation ({@link #getSupportedObjectClassesByOperation()}).
* - Supported OperationOptionInfo by operation({@link #getSupportedOptionsByOperation()()}).
*
*
* TODO: add more to describe and what is expected from this call and how it is
* used.. based on OperationalAttribute etc..
*/
public final class Schema {
/**
*
*/
private final Set _declaredObjectClasses;
private final Set _declaredOperationOptions;
private final Map,Set>
_supportedObjectClassesByOperation;
private final Map,Set>
_supportedOptionsByOperation;
/**
* Public only for serialization; please use
* SchemaBuilder instead.
* @param info
* @param supportedObjectClassesByOperation
*/
public Schema(Set info,
Set options,
Map,Set> supportedObjectClassesByOperation,
Map,Set> supportedOptionsByOperation) {
_declaredObjectClasses = CollectionUtil.newReadOnlySet(info);
_declaredOperationOptions = CollectionUtil.newReadOnlySet(options);
//make read-only
{
Map,Set> temp =
new HashMap,Set>();
for (Map.Entry,Set> entry :
supportedObjectClassesByOperation.entrySet()) {
Class op =
entry.getKey();
Set resolvedClasses =
CollectionUtil.newReadOnlySet(entry.getValue());
temp.put(op, resolvedClasses);
}
_supportedObjectClassesByOperation = CollectionUtil.asReadOnlyMap(temp);
}
//make read-only
{
Map,Set> temp =
new HashMap,Set>();
for (Map.Entry,Set> entry :
supportedOptionsByOperation.entrySet()) {
Class op =
entry.getKey();
Set resolvedClasses =
CollectionUtil.newReadOnlySet(entry.getValue());
temp.put(op, resolvedClasses);
}
_supportedOptionsByOperation = CollectionUtil.asReadOnlyMap(temp);
}
}
/**
* Returns the set of object classes that are defined in the schema, regardless
* of which operations support them.
*/
public Set getObjectClassInfo() {
return _declaredObjectClasses;
}
/**
* Returns the ObjectClassInfo for the given type.
* @param type The type to find.
* @return the ObjectClassInfo for the given type or null if not found.
*/
public ObjectClassInfo findObjectClassInfo(String type) {
Assertions.nullCheck(type, "type");
for (ObjectClassInfo info : _declaredObjectClasses) {
if ( info.is(type) ) {
return info;
}
}
return null;
}
/**
* Returns the set of operation options that are defined in the schema, regardless
* of which operations support them.
* @return The options defined in this schema.
*/
public Set getOperationOptionInfo() {
return _declaredOperationOptions;
}
/**
* Returns the OperationOptionInfo for the given name.
* @param name The name to find.
* @return the OperationOptionInfo for the given name or null if not found.
*/
public OperationOptionInfo findOperationOptionInfo(String name) {
Assertions.nullCheck(name, "name");
for (OperationOptionInfo info : _declaredOperationOptions) {
if ( info.getName().equals(name) ) {
return info;
}
}
return null;
}
/**
* Returns the supported object classes for the given operation.
* @param apiop The operation.
* @return the supported object classes for the given operation.
*/
public Set getSupportedObjectClassesByOperation(Class apiop) {
Set rv = _supportedObjectClassesByOperation.get(apiop);
if ( rv == null ) {
@SuppressWarnings("unchecked")
Set empty = Collections.EMPTY_SET;
return empty;
}
else {
return rv;
}
}
/**
* Returns the supported options for the given operation.
* @param apiop The operation.
* @return the supported options for the given operation.
*/
public Set getSupportedOptionsByOperation(Class apiop) {
Set rv = _supportedOptionsByOperation.get(apiop);
if ( rv == null ) {
@SuppressWarnings("unchecked")
Set empty = Collections.EMPTY_SET;
return empty;
}
else {
return rv;
}
}
/**
* Returns the set of object classes that apply to a particular operation.
* @return the set of object classes that apply to a particular operation.
*/
public Map,Set> getSupportedObjectClassesByOperation() {
return _supportedObjectClassesByOperation;
}
/**
* Returns the set of operation options that apply to a particular operation.
* @return the set of operation options that apply to a particular operation.
*/
public Map,Set> getSupportedOptionsByOperation() {
return _supportedOptionsByOperation;
}
/**
* {@inheritDoc}
*/
@Override
public String toString() {
return SerializerUtil.serializeXmlObject(this, false);
}
/**
* {@inheritDoc}
*/
@Override
public boolean equals(Object obj) {
if (obj instanceof Schema) {
Schema other = (Schema)obj;
if (!CollectionUtil.equals(getObjectClassInfo(),other.getObjectClassInfo())) {
return false;
}
if (!CollectionUtil.equals(getOperationOptionInfo(),other.getOperationOptionInfo())) {
return false;
}
if (!CollectionUtil.equals(_supportedObjectClassesByOperation,
other._supportedObjectClassesByOperation)) {
return false;
}
if (!CollectionUtil.equals(_supportedOptionsByOperation,
other._supportedOptionsByOperation)) {
return false;
}
return true;
}
return false;
}
/**
* Create a hash code from all the object info objects.
* @see java.lang.Object#hashCode()
*/
@Override
public int hashCode() {
return _declaredObjectClasses.hashCode();
}
}