Package org.identityconnectors.framework.common

Class FrameworkUtil

java.lang.Object
org.identityconnectors.framework.common.FrameworkUtil
public final class FrameworkUtil extends Object

  • Method Details

    • spi2apis

      public static Set<Class<? extends APIOperation>> spi2apis(Class<? extends SPIOperation> spi)
      Converts a SPIOperation to an set of APIOperation.

    • allSPIOperations

      public static Set<Class<? extends SPIOperation>> allSPIOperations()
      Return all the known SPIOperations.

    • allAPIOperations

      public static Set<Class<? extends APIOperation>> allAPIOperations()
      Return all the known APIOperations.

    • getDefaultSupportedOperations

      public static Set<Class<? extends APIOperation>> getDefaultSupportedOperations(Class<? extends Connector> connector)
      Determines the default set of operations that a Connector supports.

    • getUnconditionallySupportedOperations

      public static Set<Class<? extends APIOperation>> getUnconditionallySupportedOperations()
      Returns the set of operations that are always supported.
      Returns:
      the set of operations that are always supported

    • getAllSupportedConfigTypes

      public static Set<Class<? extends Object>> getAllSupportedConfigTypes()

    • isSupportedConfigurationType

      public static boolean isSupportedConfigurationType(Class<?> clazz)
      Determines if the class is a supported configuration type.
      Parameters:
      clazz - the type to check against the list of supported types.
      Returns:
      true if the type is in the list otherwise false.

    • getAllSupportedAttributeTypes

      public static Set<Class<? extends Object>> getAllSupportedAttributeTypes()

    • isSupportedAttributeType

      public static boolean isSupportedAttributeType(Class<?> clazz)
      Determines if the class is a supported attribute type.
      Parameters:
      clazz - the type to check against a supported list of types.
      Returns:
      true if the type is on the supported list otherwise false.

    • checkAttributeType

      public static void checkAttributeType(Class<?> clazz)
      Determines if the class is a supported attribute type. If not it throws an IllegalArgumentException.
      • String.class
      • long.class
      • Long.class
      • char.class
      • Character.class
      • double.class
      • Double.class
      • float.class
      • Float.class
      • int.class
      • Integer.class
      • boolean.class
      • Boolean.class
      • byte.class
      • Byte.class
      • byte[].class
      • BigDecimal.class
      • BigInteger.class
      • Map.class
      Parameters:
      clazz - type to check against the support list of types.
      Throws:
      IllegalArgumentException - if the type is not on the supported list.

    • checkAttributeValue

      public static void checkAttributeValue(Object value)
      Determines if the class of the object is a supported attribute type. If not it throws an IllegalArgumentException.
      Parameters:
      value - The value to check or null.
      Throws:
      IllegalArgumentException - If the class of the object is a supported attribute type.

    • checkAttributeValue

      public static void checkAttributeValue(String name, Object value)
      Determines if the class of the object is a supported attribute type. If not it throws an IllegalArgumentException.
      Parameters:
      name - The name of the attribute to check
      value - The value to check or null.
      Throws:
      IllegalArgumentException - If the class of the object is a supported attribute type.

    • checkOperationOptionType

      public static void checkOperationOptionType(Class<?> clazz)
      Determines if the class is a supported type for an OperationOption. If not it throws an IllegalArgumentException.
      Parameters:
      clazz - type to check against the support list of types.
      Throws:
      IllegalArgumentException - if the type is not on the supported list.

    • checkOperationOptionValue

      public static void checkOperationOptionValue(Object value)
      Determines if the class of the object is a supported attribute type. If not it throws an IllegalArgumentException.
      Parameters:
      value - The value to check or null.
      Throws:
      IllegalArgumentException - if the class of the object is a supported attribute type

    • getUidIfGetOperation

      public static Uid getUidIfGetOperation(Filter filter)
      Check if SearchOp was invoked from GetApiOp or SearchApiOp.
      Parameters:
      filter - the query parameter of SearchOp.executeQuery(org.identityconnectors.framework.common.objects.ObjectClass, Object, org.identityconnectors.framework.common.objects.ResultsHandler, org.identityconnectors.framework.common.objects.OperationOptions)
      Returns:
      null if invoked from SearchApiOp or Uid value if invoked GetApiOp
      Since:
      1.5

    • getFrameworkVersion

      public static Version getFrameworkVersion()
      Returns the version of the framework.
      Returns:
      the framework version; never null.