Package edu.internet2.middleware.grouper

Class FieldFinder

java.lang.Object
edu.internet2.middleware.grouper.FieldFinder
public class FieldFinder extends Object
Find fields.

Version:
$Id: FieldFinder.java,v 1.48 2009-08-11 20:18:08 mchyzer Exp $

  • Constructor Details

    • FieldFinder

      public FieldFinder()

  • Method Details

    • fieldGrouperCache

      public static GrouperCache<Boolean,Map<String,Field>> fieldGrouperCache()
       return the field cache.
 
 Customize with:
   <cache  name="edu.internet2.middleware.grouper.FieldFinder.fieldCache"
        maxElementsInMemory="10000"
        eternal="false"
        timeToIdleSeconds="86400"
        timeToLiveSeconds="86400"
        overflowToDisk="false"
 />
      Returns:
      cache

    • findFieldId

      @Deprecated public static String findFieldId(String name, String type)
      Deprecated.
      Parameters:
      name -
      type -
      Returns:
      the field id

    • findFieldId

      public static String findFieldId(String name, String type, boolean exceptionIfNull)
      Parameters:
      name -
      type -
      exceptionIfNull -
      Returns:
      the field id

    • findAllIdsByType

      public static List<String> findAllIdsByType(FieldType type)
      find all ids by type
      Parameters:
      type -
      Returns:
      all ids by type

    • find

      @Deprecated public static Field find(String name) throws SchemaException
      Deprecated.
      Get the specified field. 
       Field f = FieldFinder.find(field);
      Parameters:
      name - Name of Field to return.
      Returns:
      field
      Throws:
      SchemaException

    • find

      public static Field find(String name, boolean exceptionIfNotFound)
      Get the specified field. 
       Field f = FieldFinder.find(field);
      Parameters:
      name - Name of Field to return.
      exceptionIfNotFound - true if exception if not found, otherwise null
      Returns:
      field
      Throws:
      SchemaException

    • find

      public static Field find(String name, boolean exceptionIfNotFound, boolean includePrivilegeSearch) throws SchemaException
      Get the specified field. 
       Field f = FieldFinder.find(field);
      Parameters:
      name - Name of Field to return.
      exceptionIfNotFound - true if exception if not found, otherwise null
      includePrivilegeSearch - if should also use name as privilege
      Returns:
      field
      Throws:
      SchemaException

    • findById

      @Deprecated public static Field findById(String fieldId)
      Deprecated.
      use the overload
      Get the specified field by id.
      Parameters:
      fieldId - fieldId
      Returns:
      the field or null if fieldId is blank. will throw runtime exception if the field is not found

    • findById

      public static Field findById(String fieldId, boolean exceptionIfNull)
      Get the specified field by id.
      Parameters:
      fieldId - fieldId
      exceptionIfNull -
      Returns:
      the field or null if fieldId is blank. will throw runtime exception if the field is not found

    • findAll

      public static Set findAll() throws GrouperException
      Find all fields. 
       Set fields = FieldFinder.findAll();
      Returns:
      Set of Field objects.
      Throws:
      GrouperException

    • findAllByGroupType

      public static Set<Field> findAllByGroupType(GroupType groupType) throws GrouperDAOException
      Parameters:
      groupType -
      Returns:
      set of fields
      Throws:
      GrouperDAOException

    • findAllByGroupType

      public static Set<Field> findAllByGroupType(String groupTypeId) throws GrouperDAOException
      Parameters:
      groupTypeId -
      Returns:
      set of fields
      Throws:
      GrouperDAOException

    • findAllByType

      public static Set<Field> findAllByType(FieldType type) throws SchemaException
      Find all fields of the specified type. 
       Set types = FieldFinder.findAllByType(type);
      Parameters:
      type -
      Returns:
      set of fields
      Throws:
      SchemaException

    • internal_updateKnownFields

      public static Map<String,Field> internal_updateKnownFields()
      Returns:
      map

    • clearCache

      public static void clearCache()
      clear cache (e.g. if schema export)

    • main

      public static void main(String[] args) throws Exception
      Parameters:
      args -
      Throws:
      Exception

    • findInternalIdsByNames

      public static Map<String,Long> findInternalIdsByNames(Set<String> fieldNames)
      find field internal ids by name (exception if not found)
      Parameters:
      fieldNames -
      Returns:
      the map