com.waveset.ui
Class FormUtil

java.lang.Object
  extended bycom.waveset.ui.FormUtil

public class FormUtil
extends java.lang.Object

This class provides a collection of utility methods that are intended to be called from XPRESS expressions with Form objects. They can be used to populate lists of allowed values, validate input, etc.


Nested Class Summary
static class FormUtil.StringComparator
          Internal class that implenents the Comparator interface for sorting the object names.
 
Field Summary
static java.lang.String code_id
           
 
Constructor Summary
FormUtil()
           
 
Method Summary
static java.lang.String buildDn(java.lang.String name, java.lang.String baseContext)
          Takes a names and the baseContext to append to the name.
static java.util.List buildDns(java.util.List names, java.lang.String baseContext)
          Takes a list of names and the baseContext to append to each token in the list.
static java.util.List buildDns(java.lang.String names, java.lang.String delimeter, java.lang.String baseContext)
          Takes a string, the delimeter with which to parse the string, and the baseContext to append to each token in the string.
static java.lang.Object callResourceMethod(LighthouseContext context, java.lang.String resourceName, java.lang.String methodName, java.util.Map args)
          This method will invoke the specified method on the specified resource, passing the given Map of arguments into the method, if the current subject has view access to the specified resource.
static java.lang.Object checkStringQualityPolicy(LighthouseContext s, java.lang.String policy, java.lang.Object value, java.util.Map map, java.util.List pwdhistory, java.lang.String owner)
          Check string value against string policy Return true if string passes policy tests or error msg(s) if fails Add option returnNull=true to map and a success will return null.
static void clearResourceObjectListCache(LighthouseContext session, java.lang.String objectType, java.util.List resourceList)
          Variant that takes a list of resourceids and an existing session
static void clearResourceObjectListCache(LighthouseContext session, java.lang.String objectType, java.lang.String resourceId)
          Variant that takes a single resourceid and an existing session.
static void clearResourceObjectListCache(LighthouseContext session, java.lang.String objectType, java.lang.String resourceId, java.util.Map templateParameters)
          Variant that takes a single resourceid (supporting resource templates) and an existing session.
static void clearResourceObjectListCache(java.lang.String subjectString, java.lang.String objectType, java.util.List resourceList)
          Variant that takes a list of resourceids and a subject string
static void clearResourceObjectListCache(java.lang.String subjectString, java.lang.String objectType, java.lang.String resourceId)
          Variant that takes a single resourceId and a subject string.
static void clearResourceObjectListCache(java.lang.String subjectString, java.lang.String objectType, java.lang.String resourceId, java.util.Map templateParameters)
          Variant that takes a single resourceid (supporting resource templates) and a subject string.
static java.lang.Boolean controlsAtLeastOneOrganization(LighthouseContext s, java.util.List organizations)
          This method will return true if the current authenticated Lighthouse user controls any one of the organizations in the list; otherwise, returns false.
static java.lang.String convertDateToString(java.util.Date date, java.lang.String simpleDateFormatPattern)
          Convert a date into a different date into the requested string format.
static java.lang.String convertDateToString(java.lang.String dateStr, java.lang.String simpleDateFormatPattern)
          Convert the string representation for a date into a different date string format.
static java.lang.String formatDate(java.lang.String src)
          Given a string containing the long integer representation of a Date, return a formatted date string.
static java.lang.String formatTransactionText(java.util.Locale locale, java.util.List attrNames, java.util.List attrValues)
          Used for formatting the transaction text to be signed for signed approvals.
static java.lang.String getAccountAttributeType(LighthouseContext session, java.lang.String fqAttrName)
          Returns the 'type' of an attribute
static java.util.List getAdministrators(LighthouseContext lc)
          Return a string array of Administrator names
static java.util.List getAdministrators(Session s, java.util.List existing)
          Deprecated. - replaced by getUsers(LighthouseContext, Map)
specifying the "userType" equals "administrator" option and "current" option to specify the list of current users instead of the "existing" param.

 <invoke class='com.waveset.ui.FormUtil' name='getUsers'>
    <ref>:display.session</ref>
    <map>
      <s>conditions</s>
      <list>
        <new class='com.waveset.object.AttributeCondition'>
          <s>userType</s>
          <s>equals</s>
          <s>administrator</s>
        </new>
      </list>
      <s>current</s>
      <ref>existing</ref>
    </map>
 </invoke>

static java.util.List getAdministrators(Session s, java.util.Map options)
          Deprecated. - replaced by getUsers(LighthouseContext, Map)
specifying the "userType" equals "administrator" option as follows:

 <invoke class='com.waveset.ui.FormUtil' name='getUsers'>
    <ref>:display.session</ref>
    <map>
      <s>conditions</s>
      <list>
        <new class='com.waveset.object.AttributeCondition'>
          <s>userType</s>
          <s>equals</s>
          <s>administrator</s>
        </new>
      </list>
    </map>
 </invoke>

static java.util.List getAdminRoles(LighthouseContext s, java.util.Map options)
          Returns a list of capabilities in the authorization scope of the specified lighthouse context.
static java.util.List getApplications(LighthouseContext s)
          Deprecated. use getApplications(LighthouseContext s, Map options) instead
static java.util.List getApplications(LighthouseContext s, java.util.List current)
          Deprecated. use getApplications(LighthouseContext s, Map options) instead
static java.util.List getApplications(LighthouseContext s, java.util.Map options)
          Returns a list of applications in the authorization scope of the specified lighthouse context.
static java.util.List getApproverNames(Session s)
          Deprecated. - replaced by #getUsers(Session, Map)
specifying the "userType" equals "approver" option as follows:

 <invoke class='com.waveset.ui.FormUtil' name='getUsers'>
    <ref>:display.session</ref>
    <map>
      <s>conditions</s>
      <list>
        <new class='com.waveset.object.AttributeCondition'>
          <s>userType</s>
          <s>equals</s>
          <s>approver</s>
        </new>
      </list>
    </map>
 </invoke>

static java.util.List getApproverNames(Session s, java.util.List existing)
          Deprecated. - replaced by getUsers(LighthouseContext, Map)
specifying the "userType" equals "approver" option and "current" option to specify the list of current users instead of the "existing" param.

 <invoke class='com.waveset.ui.FormUtil' name='getUsers'>
    <ref>:display.session</ref>
    <map>
      <s>conditions</s>
      <list>
        <new class='com.waveset.object.AttributeCondition'>
          <s>userType</s>
          <s>equals</s>
          <s>approver</s>
        </new>
      </list>
      <s>current</s>
      <ref>existing</ref>
    </map>
 </invoke>

static java.util.List getApprovers(Session s)
          Deprecated. - replaced by getUsers(LighthouseContext, Map)
specifying the "userType" equals "approver" option as follows:

 <invoke class='com.waveset.ui.FormUtil' name='getUsers'>
    <ref>:display.session</ref>
    <map>
      <s>conditions</s>
      <list>
        <new class='com.waveset.object.AttributeCondition'>
          <s>userType</s>
          <s>equals</s>
          <s>approver</s>
        </new>
      </list>
    </map>
 </invoke>

static java.util.List getApprovers(Session s, java.util.List existing)
          Deprecated. - replaced by getUsers(LighthouseContext, Map)
specifying the "userType" equals "approver" option and "current" option to specify the list of current users instead of the "existing" param.

 <invoke class='com.waveset.ui.FormUtil' name='getUsers'>
    <ref>:display.session</ref>
    <map>
      <s>conditions</s>
      <list>
        <new class='com.waveset.object.AttributeCondition'>
          <s>userType</s>
          <s>equals</s>
          <s>approver</s>
        </new>
      </list>
      <s>current</s>
      <ref>existing</ref>
    </map>
 </invoke>

static java.util.Map getAttributesSelectOptionGroupMap(LighthouseContext s)
          Builds data structure appropriate for the 'optionsGroupMap' property of a Select component that displays all form and resource attributes.
static java.util.Map getAttributesSelectOptionGroupMap(LighthouseContext s, java.util.Map additionalEntries, java.lang.String additionalEntriesMsg)
          Builds data structure appropriate for the 'optionsGroupMap' property of a Select component that displays resource attributes.
static java.util.Map getAttributesSelectValueMap(LighthouseContext s)
          Builds data structure appropriate for the 'valueMap' property of a Select component that displays all form and resource attributes.
static java.util.List getAuditActions(LighthouseContext s, java.lang.String objectType)
          Get a list of audit actions available to the given content for the objectType.
static java.util.List getAuditActions(LighthouseContext s, java.lang.String objectType, boolean includeAll)
           
static java.util.Map getAuditFormatterMap(LighthouseContext context)
           
static java.util.List getAuditObjectTypes(LighthouseContext s)
          Get a list of audit object types available to the given context.
static java.util.Map getAuditPublisherMap(LighthouseContext context)
           
static java.util.List getAuditPublisherOptions(java.lang.String className)
           
static java.util.List getAuditStatusList(LighthouseContext s)
          Get a list of audit status types available to the given context.
static java.util.List getAuditStatusList(LighthouseContext s, boolean includeAll)
           
static java.util.Map getAvailableCharsets()
           
static java.util.List getAvailablePDFFonts()
           
static java.util.List getCapabilities(LighthouseContext s)
          Deprecated. use getCapabilities(LighthouseContext s, Map options) instead
static java.util.List getCapabilities(LighthouseContext s, java.util.List current)
          Deprecated. use getCapabilities(LighthouseContext s, Map options) instead
static java.util.List getCapabilities(LighthouseContext s, java.util.List current, java.util.Map options)
          Deprecated. use getCapabilities(LighthouseContext s, Map options) instead
static java.util.List getCapabilities(LighthouseContext s, java.util.Map options)
          Returns a list of capabilities in the authorization scope of the specified lighthouse context.
static java.util.List getCapabilities(LighthouseContext s, java.lang.String matchType, java.lang.String value)
          Deprecated. use getCapabilities(LighthouseContext s, Map options) instead
static java.lang.String getCodeId(java.lang.Class c)
          Get the code id from the class.
static java.lang.String getCodeId(java.lang.String c)
          Get the code id from the class specified by the string.
static java.lang.String getCodeIdVersion(java.lang.Class clazz)
          Get the version of the code id from the class.
static java.lang.String getCodeIdVersion(java.lang.String clazz)
          Get the version of the code id from the class.
static java.util.Locale getDisplayLocale(Session session)
          Extract the locale from the session.
static java.lang.String getDnComponent(java.lang.String dn, java.lang.String componentName)
          Given a dn's and the component type to return (e.g.
static java.util.List getFormFieldNames(LighthouseContext s, java.lang.String processName)
          Returns a list of attributes from a form.
static java.util.List getInstalledLocales(java.util.List localeIds, java.util.Locale displayLocale)
          This can be used as the valueMap property of a Select component to allow the user to select their locale.
static java.util.List getListOfDnComponents(java.util.List dnlist, java.lang.String componentName)
          Given a list of dn's and the component type to return (e.g.
static java.util.List getListOfDnComponents(java.lang.String dn, java.lang.String componentName)
          Given a dn's and the component type to return (e.g.
static java.lang.String getLocalizedHelpAsString(Session displaySession, java.lang.Object help)
          This allows us to use Messsages for help objects.
static java.util.List getLoginInterfaceDisplayNames(LighthouseContext notUsed)
          Return the current list of Lighthouse login interface display names (such as message catalog keys).
static java.lang.String getMemberOrganization(LighthouseContext s)
          Get the name of the first member object group for the administrator currently logged into the session.
static PersistentObject getObject(LighthouseContext s, java.lang.String typeName, java.lang.String id)
          Get an object from the repository, subject to authorization.
static java.util.List getObjectAttributeNames(GenericObject obj)
          Returns the (String) List of attribute names for the supplied GenericObject
static java.util.List getObjectDisplayNames(LighthouseContext s, java.lang.String typeName, java.util.Map options)
          Returns a list of display names of objects of a given type to which the session owner (subject) has access.
static java.util.List getObjectNames(LighthouseContext s, java.lang.String typeName)
          Return a list of the names of objects if a given type to which the session owner has access.
static java.util.List getObjectNames(LighthouseContext s, java.lang.String typeName, java.util.List current)
          Deprecated. use getObjectNames(LighthouseContext s, String typeName, Map options) instead
static java.util.List getObjectNames(LighthouseContext s, java.lang.String typeName, java.util.List current, java.util.Map options)
          Deprecated. use getObjectNames(LighthouseContext s, String typeName, Map options) instead
static java.util.List getObjectNames(LighthouseContext s, java.lang.String typeName, java.util.Map options)
          Returns a list of names of objects of a given type to which the session owner (subject) has access.
static java.util.List getObjectNames(LighthouseContext s, java.lang.String typeName, java.lang.String attrName, java.lang.String attrValue, java.util.List current)
          Deprecated. use getObjectNames(LighthouseContext s, String typeName, Map options) instead
static java.util.List getObjectNames(LighthouseContext s, java.lang.String typeName, java.lang.String attrName, java.lang.String attrValue, java.util.List current, java.util.Map options)
          Deprecated. use getObjectNames(LighthouseContext s, String typeName, Map options) instead
static java.util.List getObjectNames(LighthouseContext s, Type type, java.lang.String attrName, java.lang.String attrValue, java.util.List current)
          Deprecated. use getObjectNames(LighthouseContext s, String typeName, Map options) instead
static java.util.List getObjectNames(LighthouseContext s, Type type, java.lang.String attrName, java.lang.String attrValue, java.util.List current, java.util.Map options)
          Deprecated. use getObjectNames(LighthouseContext s, String typeName, Map options) instead
static ObjectRef getObjectRef(LighthouseContext s, java.lang.String typeName, java.lang.String id)
          Get an ObjectRef from the repository given the type and name or id, subject to authorization.
static java.util.List getObjectRefList(LighthouseContext s, java.lang.String typeName, java.util.List ids)
           
static java.lang.String getOrganizationDisplayableNameByUserId(LighthouseContext s, java.util.List userIds)
          Return the displayableName for the common objectGroup which the userIds belong in.
static java.util.List getOrganizations(LighthouseContext s)
          Deprecated. Use getOrganizationsDisplayNames(LighthouseContext s, Map options) instead
static java.util.List getOrganizations(LighthouseContext s, boolean pathPrefixes)
          Deprecated. Use getOrganizationsDisplayNames(LighthouseContext s, Map options) instead
static java.util.List getOrganizations(LighthouseContext s, boolean pathPrefixes, java.util.List current)
          Deprecated. Use getOrganizationsDisplayNames(LighthouseContext s, Map options) instead
static java.util.List getOrganizations(LighthouseContext s, java.util.List current)
          Deprecated. Use getOrganizationsDisplayNames(LighthouseContext s, Map options) instead
static java.util.List getOrganizationsDisplayNames(LighthouseContext s)
          Short cut for calling getOrganizationsDisplayNames(LighthouseContext s, Map options) with no options.
static java.util.List getOrganizationsDisplayNames(LighthouseContext s, boolean pathPrefixes)
          Deprecated. Use getOrganizationsDisplayNames(LighthouseContext s, Map options) instead
static java.util.List getOrganizationsDisplayNames(LighthouseContext s, boolean pathPrefixes, java.util.List current)
          Deprecated. Use getOrganizationsDisplayNames(LighthouseContext s, Map options) instead
static java.util.List getOrganizationsDisplayNames(LighthouseContext s, java.util.List current)
          Deprecated. Use getOrganizationsDisplayNames(LighthouseContext s, Map options) instead
static java.util.List getOrganizationsDisplayNames(LighthouseContext s, java.util.Map options)
           
static java.util.List getOrganizationsDisplayNamesWithPrefixes(LighthouseContext s)
          Deprecated. Use getOrganizationsDisplayNames(LighthouseContext s, Map options) instead
static java.util.List getOrganizationsDisplayNamesWithPrefixes(LighthouseContext s, java.util.List current)
          Deprecated. Use getOrganizationsDisplayNames(LighthouseContext s, Map options) instead
static java.util.List getOrganizationsDisplayNamesWithRight(LighthouseContext s, java.lang.String type, java.lang.String targetRight)
          Calls #getOrganizationsDisplayNamesWithRights(LighthouseContext, String, List, Map) with targetRight wrapped into a list and null options.
static java.util.List getOrganizationsDisplayNamesWithRight(LighthouseContext s, java.lang.String type, java.lang.String targetRight, java.util.Map options)
          Calls #getOrganizationsDisplayNamesWithRights(LighthouseContext, String, List, Map) with targetRight wrapped into a list.
static java.util.List getOrganizationsDisplayNamesWithRights(LighthouseContext s, java.lang.String type, java.util.List targetRights)
          Calls #getOrganizationsDisplayNamesWithRights(LighthouseContext, String, List, Map) with null options.
static java.util.List getOrganizationsDisplayNamesWithRights(LighthouseContext s, java.lang.String type, java.util.List targetRights, java.util.Map options)
           
static java.util.List getOrganizationsWithPrefixes(LighthouseContext s)
          Deprecated. Use getOrganizationsDisplayNames(LighthouseContext s, Map options) instead
static java.util.List getOrganizationsWithPrefixes(LighthouseContext s, java.util.List current)
          Deprecated. Use getOrganizationsDisplayNames(LighthouseContext s, Map options) instead
static java.lang.String getOrgPath(ObjectGroup group)
           
static java.util.List getPolicies(LighthouseContext s)
           
static java.util.List getPolicies(LighthouseContext s, java.util.Map options)
          Return a string array of policy names of the specified type.
static java.util.List getPolicies(LighthouseContext s, java.lang.String currentPolicy)
          Special call to get the policies and if the current policy is not on the list, add it to the list.
static java.util.List getPolicies(LighthouseContext s, java.lang.String type, java.lang.String currentPolicy)
          Return a string array of policy names of the specified type.
static java.util.List getPrivateApplications(LighthouseContext s, java.lang.String roleName)
          This was the original name, keep for backward compatibility.
static java.util.List getPrivateResources(LighthouseContext s, java.lang.String roleName)
          This was the original name, keep it around for backward compatibility.
static java.lang.String getRelativeDateString(int ord, int day, int mo, java.lang.String simpleDateFormatPattern)
          Generates a date string expressed in a future time such as "the second Monday in October".
static java.lang.String getRelativeDateString(int field, int amount, java.lang.String simpleDateFormatPattern)
          Generates a data string expressed as a number of units from now such as "5 minutes from now"
static java.util.Map getRepetitionUnitsMap()
          Get a map that contains the TaskSchedule repetition units.
static java.lang.Object getResourceAccountAttributeMapping(LighthouseContext context, java.lang.String resourceName, java.lang.String leftHandSideName)
          For the resource specified by resourceName, return the value for the resource account attribute in the schema map that corresponds to the IDM attribute with name leftHandSideName.
static java.lang.Object getResourceAccountAttributeType(LighthouseContext context, java.lang.String resourceName, java.lang.String leftHandSideName)
          For the resource specified by resourceName, return the type of the resource account attribute in the schema map that corresponds to the IDM attribute with name leftHandSideName.
static java.lang.Object getResourceAttributeFromResource(LighthouseContext context, java.lang.String resourceName, java.lang.String resourceAttribute)
          For the resource specified by resourceName, return the value for the resource attribute specified by resourceAttribute.
static java.util.List getResourceAttributes(LighthouseContext s, java.lang.String resource)
          Return a list of the attributes in the schema map for a particular resource.
static java.lang.String getResourceIdentity(Session session, java.lang.String resourceId)
           
static java.lang.String getResourceIdentity(java.lang.String subjectString, java.lang.String resourceId)
           
static GenericObject getResourceObject(LighthouseContext session, java.lang.String resourceId, java.lang.String objectType, java.lang.String objectId, java.util.Map options)
          Returns the requested objectId of the requested objectType from the resource
static GenericObject getResourceObject(java.lang.String subjectString, java.lang.String resourceId, java.lang.String objectType, java.lang.String objectId, java.util.Map options)
          Returns the requested objectId of the requested objectType from the resource
static java.util.List getResourceObjects(LighthouseContext session, java.lang.String objectType, java.lang.String resourceId, java.util.Map options)
           
static java.util.List getResourceObjects(LighthouseContext session, java.lang.String objectType, java.lang.String resourceId, java.util.Map options, java.lang.String cacheList, java.lang.String cacheTimeout, java.lang.String clearCacheIfExists)
          Same function as getResourceObjects above, plus the ability to cache and manage the cache of the returned objects cachList - "true" to have the returned list of objects cached by the server; otherwise "false" cacheTimeout - if cacheList is true, this can set the number of milliseconds before the cache times out.
static java.util.List getResourceObjects(java.lang.String subjectString, java.lang.String objectType, java.lang.String resourceId, java.util.Map options)
           
static java.util.List getResourceObjects(java.lang.String subjectString, java.lang.String objectType, java.lang.String resourceId, java.util.Map options, java.lang.String cacheList, java.lang.String cacheTimeout, java.lang.String clearCacheIfExists)
          Same function as getResourceObjects above, plus the ability to cache and manage the cache of the returned objects cachList - "true" to have the returned list of objects cached by the server; otherwise "false" cacheTimeout - if cacheList is true, this can set the number of milliseconds before the cache times out.
static java.util.List getResourceObjectTypeAttributeNames(LighthouseContext context, java.lang.String resourceName, java.lang.String objectType)
           
static java.util.List getResources(LighthouseContext s)
           
static java.util.List getResources(LighthouseContext s, java.util.List current)
           
static java.util.List getResources(LighthouseContext s, java.util.Map options)
          Returns a list of resources in the authorization scope of the specified lighthouse context.
static java.util.List getResources(LighthouseContext s, java.lang.String matchType, java.lang.String value)
          Build a list of the names of resources that match a particular type (like LDAP).
static java.util.List getResources(LighthouseContext s, java.lang.String matchType, java.lang.String value, java.util.List current)
           
static java.util.List getResourceSchemaAttributeNames(LighthouseContext context, java.lang.String nameOrId)
           
static java.util.List getResourceSchemaResourceAttributeNames(LighthouseContext context, java.lang.String nameOrId)
           
static java.util.List getResourcesSupportingContainerObjectTypes(LighthouseContext s)
           
static java.util.List getResourcesSupportingContainerObjectTypes(LighthouseContext s, java.util.Map options)
           
static java.util.List getResourcesSupportingObjectTypes(LighthouseContext s, java.util.List objectTypes)
           
static java.util.List getResourcesSupportingObjectTypes(LighthouseContext s, java.util.List objectTypes, java.util.List current)
           
static java.util.List getResourcesSupportingObjectTypes(LighthouseContext s, java.util.List objectTypes, java.util.List current, java.util.Map options)
           
static java.util.List getResourcesSupportingObjectTypes(LighthouseContext s, java.util.List objectTypes, java.util.Map options)
           
static java.util.List getRoles(LighthouseContext s)
           
static java.util.List getRoles(LighthouseContext s, java.util.List current)
          This variant allows a list of names to be included in the returned list.
static java.util.List getRoles(LighthouseContext s, java.util.Map options)
          Returns a list of roles in the authorization scope of the specified lighthouse context.
static java.util.List getRoles(LighthouseContext s, java.lang.String current)
          This variant allows a specific name to be included in the returned list.
static java.lang.String getServletContextPath(RequestState request)
           
static Session getSessionForActiveSyncResource(java.lang.String name)
           
static java.util.List getSimilarApproverNames(Session s)
          Deprecated. - replaced by getUsers(LighthouseContext, Map)
specifying the "userType" equals "administrator" option and "similarTo" option with a value of the current user's name

 <invoke class='com.waveset.ui.FormUtil' name='getUsers'>
    <ref>:display.session</ref>
    <map>
      <s>conditions</s>
      <list>
        <new class='com.waveset.object.AttributeCondition'>
          <s>userType</s>
          <s>equals</s>
          <s>administrator</s>
        </new>
        <new class='com.waveset.object.AttributeCondition'>
          <s>similarTo</s>
          <s>equals</s>
          <invoke name='getUser'>
            <ref>:display.session</ref>
          </invoke>
        </new>
      </list>
    </map>
 </invoke>

static java.util.List getSimilarApproverNames(Session s, java.lang.String admin)
          Deprecated. - replaced by getUsers(LighthouseContext, Map)
specifying the "userType" equals "administrator" option and "similarTo" option with a value of the current user's name

 <invoke class='com.waveset.ui.FormUtil' name='getUsers'>
    <ref>:display.session</ref>
    <map>
      <s>conditions</s>
      <list>
        <new class='com.waveset.object.AttributeCondition'>
          <s>userType</s>
          <s>equals</s>
          <s>administrator</s>
        </new>
        <new class='com.waveset.object.AttributeCondition'>
          <s>similarTo</s>
          <s>equals</s>
          <ref>admin</ref>
        </new>
      </list>
    </map>
 </invoke>

static java.util.List getSimilarApprovers(Session s)
          Deprecated. - replaced by getUsers(LighthouseContext, Map)
specifying the "userType" equals "administrator" option and "similarTo" option with a value of the current user's name

 <invoke class='com.waveset.ui.FormUtil' name='getUsers'>
    <ref>:display.session</ref>
    <map>
      <s>conditions</s>
      <list>
        <new class='com.waveset.object.AttributeCondition'>
          <s>userType</s>
          <s>equals</s>
          <s>administrator</s>
        </new>
        <new class='com.waveset.object.AttributeCondition'>
          <s>similarTo</s>
          <s>equals</s>
          <invoke name='getUser'>
            <ref>:display.session</ref>
          </invoke>
        </new>
      </list>
    </map>
 </invoke>

static java.util.List getSimilarApprovers(Session s, java.lang.String admin)
          Deprecated. - replaced by getUsers(LighthouseContext, Map)
specifying the "userType" equals "administrator" option and "similarTo" option with a value of the current user's name

 <invoke class='com.waveset.ui.FormUtil' name='getUsers'>
    <ref>:display.session</ref>
    <map>
      <s>conditions</s>
      <list>
        <new class='com.waveset.object.AttributeCondition'>
          <s>userType</s>
          <s>equals</s>
          <s>administrator</s>
        </new>
        <new class='com.waveset.object.AttributeCondition'>
          <s>similarTo</s>
          <s>equals</s>
          <ref>admin</ref>
        </new>
      </list>
    </map>
 </invoke>

static java.util.Map getStartupTypesMap()
          Get a map that contains the ActiveSync startup types.
static java.util.List getSubordinates(LighthouseContext s, java.lang.String manager, java.util.Map options)
          Get the managerial subordinates of a user.
static java.util.List getTimeZoneIdToDisplayNameMap(java.util.Locale locale)
          This was too complex to manage with express.
static java.lang.String getTypeDisplayName(LighthouseContext s, java.lang.String typeName)
          Get the display name of a Type, given it name.
static java.util.Map getTypeDisplayNamesWithRights(LighthouseContext s)
          Returns the set of types with rights that are not deprecated and have a valid java class.
static java.util.List getTypeNamesWithEncryptedData()
          List object types that support having encrypted data within
static java.util.List getTypeObjectsAvailableToOrg(LighthouseContext s, java.lang.String typestr, java.lang.String orgid)
          Returns a list, for use as allowedValues of a multi-select, of all member objects of the specified org Id and typestr
static java.util.List getTypesWithRights(LighthouseContext s)
           
static java.util.List getUnassignedAdminRoles(LighthouseContext s, java.util.List current)
          Build a list of adminrole names suitable for the assigned adminroles of an administrator.
static java.util.List getUnassignedAdminRoles(LighthouseContext s, java.util.List current, java.util.Map options)
          Build a list of capability names suitable for the assigned adminroles of an administrator.
static java.util.List getUnassignedApplications(LighthouseContext s, java.util.List roleNames, java.util.List current)
           
static java.util.List getUnassignedApplications(LighthouseContext s, java.util.List roleNames, java.util.Map options)
           
static java.util.List getUnassignedApplications(LighthouseContext s, java.util.Map options)
          Build a list of application names suitable for the "private applications" of a user.
static java.util.List getUnassignedApplications(LighthouseContext s, java.lang.String roleName)
           
static java.util.List getUnassignedApplications(LighthouseContext s, java.lang.String roleName, java.util.List current)
          Build a list of names suitable for the "private applications" of a user.
static java.util.List getUnassignedCapabilities(LighthouseContext s)
           
static java.util.List getUnassignedCapabilities(LighthouseContext s, java.util.List current)
          Build a list of capability names suitable for the assigned capabilities of an administrator.
static java.util.List getUnassignedCapabilities(LighthouseContext s, java.util.List current, java.util.Map options)
          Build a list of capability names suitable for the assigned capabilities of an administrator.
static java.util.List getUnassignedCapabilities(LighthouseContext s, java.util.List current, java.lang.String currentName)
          Build a list of capability names suitable for the assigned capabilities of an administrator.
static java.util.List getUnassignedOrganizations(LighthouseContext s)
          Deprecated. - use getOrganizationsDisplayNames(LighthouseContext s, Map options) instead.
static java.util.List getUnassignedOrganizations(LighthouseContext s, java.util.List current)
          Deprecated. - use getOrganizationsDisplayNames(LighthouseContext s, Map options) instead.
static java.util.List getUnassignedOrganizationsDisplayNames(LighthouseContext s)
          Deprecated. - use getOrganizationsDisplayNames(LighthouseContext s, Map options) instead.
static java.util.List getUnassignedOrganizationsDisplayNames(LighthouseContext s, java.util.List current)
          Deprecated. - use getOrganizationsDisplayNames(LighthouseContext s, Map options) instead.
static java.util.List getUnassignedOrganizationsDisplayNames(LighthouseContext s, java.util.Map options)
          Deprecated. Use getOrganizationsDisplayNames(LighthouseContext s, Map options) instead.
static java.util.List getUnassignedOrganizationsDisplayNamesWithPrefixes(LighthouseContext s)
          Deprecated. - use getOrganizationsDisplayNames(LighthouseContext s, Map options) instead.
static java.util.List getUnassignedOrganizationsDisplayNamesWithPrefixes(LighthouseContext s, java.util.List current)
          Deprecated. - use getOrganizationsDisplayNames(LighthouseContext s, Map options) instead.
static java.util.List getUnassignedOrganizationsWithPrefixes(LighthouseContext s)
          Deprecated. - use getOrganizationsDisplayNames(LighthouseContext s, Map options) instead.
static java.util.List getUnassignedOrganizationsWithPrefixes(LighthouseContext s, java.util.List current)
          Deprecated. - use getOrganizationsDisplayNames(LighthouseContext s, Map options) instead.
static java.util.List getUnassignedResources(LighthouseContext s, java.util.List roleNames, java.util.List current)
          Deprecated. use getUnassignedResources(LighthouseContext s, Map options) instead
static java.util.List getUnassignedResources(LighthouseContext s, java.util.Map options)
          Build a list of resource names suitable for the "private resources" of a user.
static java.util.List getUnassignedResources(LighthouseContext s, java.lang.String roleName)
          Deprecated. use getUnassignedResources(LighthouseContext s, Map options) instead
static java.util.List getUnassignedResources(LighthouseContext s, java.lang.String roleName, java.util.List current)
          Deprecated. use getUnassignedResources(LighthouseContext s, Map options) instead
static java.util.List getUsers(LighthouseContext s)
          Returns a list of users in the authorization scope of the specified lighthouse context.
static java.util.List getUsers(LighthouseContext s, java.util.Map options)
          Returns a list of users in the authorization scope of the specified lighthouse context.
static java.lang.String getVersionFromCodeId(java.lang.String codeid)
          Get the version number from the CVS code id.
static java.lang.Boolean hasAllPermissions(LighthouseContext s, java.lang.String type, java.util.List rights)
          Returns true if the current authenticated Lighthouse user has all of the specified permission; otherwise, returns false.
static java.lang.Boolean hasAllPermissionsSubType(LighthouseContext s, java.lang.String type, java.util.List rights)
          Returns true if the current authenticated Lighthouse user has all the specified rights to the specified type (or any of its authtype subtypes).
static java.lang.Boolean hasAnyPermission(LighthouseContext s, java.lang.String type, java.util.List rights)
          Returns true if the current authenticated Lighthouse user has any of the specified permission; otherwise, returns false.
static java.lang.Boolean hasAnyPermissionSubType(LighthouseContext s, java.lang.String type, java.util.List rights)
          Returns true if the current authenticated Lighthouse user has any of the specified rights to the specified type (or any of its authtype subtypes).
static java.lang.Boolean hasCapabilities(LighthouseContext s, java.util.List capabilities)
          Returns true if the current authenticated Lighthouse user has the all of the specified capabilities; otherwise, returns false.
static java.lang.Boolean hasCapability(LighthouseContext s, java.lang.String capability)
          Returns true if the current authenticated Lighthouse user has the specified capability; otherwise, returns false.
static java.lang.Boolean hasPermission(LighthouseContext s, java.lang.String type, java.util.List rights)
          Deprecated. use hasAllPermissions() instead
static java.lang.Boolean hasPermissionToAnyAuthTypeSubType(LighthouseContext s, java.lang.String type, java.util.List rights)
          Returns true if the current authenticated Lighthouse user has the specified rights to the specified type or any of its authtype subtypes.
static boolean isAccountAttributeMultiValued(LighthouseContext session, java.lang.String fqAttrName)
          Determines multivalue property of an attribute
static boolean isFeatureSupported(LighthouseContext ctx, java.lang.String resourceName, java.lang.String featureName)
          Determine whether the given resource supports and has the given feature enabled.
static java.util.List listResourceObjects(LighthouseContext session, java.lang.String objectType, java.util.List resourceList, java.util.Map options, java.lang.String cacheList)
          This method returns a list of resource object names of the specified resource object type from the specified list of resources (resourceList of Ids or names).
static java.util.List listResourceObjects(LighthouseContext session, java.lang.String objectType, java.util.List resourceList, java.util.Map options, java.lang.String cacheList, java.lang.String clearCacheIfExists)
           
static java.util.List listResourceObjects(LighthouseContext session, java.lang.String objectType, java.lang.String resourceId, java.util.Map options, java.lang.String cacheList)
          Variant that takes a single resourceid and an existing session.
static java.util.List listResourceObjects(LighthouseContext session, java.lang.String objectType, java.lang.String resourceId, java.util.Map options, java.lang.String cacheList, java.lang.String clearCacheIfExists)
          Variant that takes a single resourceid and an existing session.
static java.util.List listResourceObjects(LighthouseContext session, java.lang.String objectType, java.lang.String resourceId, java.util.Map options, java.lang.String cacheList, java.lang.String cacheTimeout, java.lang.String clearCacheIfExists)
          Variant that takes a single resourceid and an existing session; Supports cacheTimeout (e.g.
static java.util.List listResourceObjects(java.lang.String subjectString, java.lang.String objectType, java.util.List resourceList, java.util.Map options, java.lang.String cacheList)
          Variant that takes a Subject string and creates a new Session.
static java.util.List listResourceObjects(java.lang.String subjectString, java.lang.String objectType, java.util.List resourceList, java.util.Map options, java.lang.String cacheList, java.lang.String clearCacheIfExists)
          Variant that takes a Subject string and creates a new Session.
static java.util.List listResourceObjects(java.lang.String subjectString, java.lang.String objectType, java.lang.String resourceId, java.util.Map options, java.lang.String cacheList)
          Variant that takes a single resourceId and a subject string.
static java.util.List listResourceObjects(java.lang.String subjectString, java.lang.String objectType, java.lang.String resourceId, java.util.Map options, java.lang.String cacheList, java.lang.String clearCacheIfExists)
          Variant that takes a single resourceId and a subject string.
static java.util.List listResourceObjects(java.lang.String subjectString, java.lang.String objectType, java.lang.String resourceId, java.util.Map options, java.lang.String cacheList, java.lang.String cacheTimeout, java.lang.String clearCacheIfExists)
          Variant that takes a single resourceId and a subject string; Supports cacheTimeout (e.g.
static java.util.List listServers(LighthouseContext s)
           
static java.util.List sort(java.util.List l)
          Sort a List by its natural ordering and return it.
static java.lang.String stripOrgPath(java.lang.String path)
          Given an organization name in "path" form, remove the path prefix.
static java.lang.String testObject(LighthouseContext s, java.lang.String typeName, java.lang.String id)
          Created for the Dell demo, where end users need to be able to launch processes to create new users, and need to test to see if a user with a certain name already exists.
static java.lang.String testUser(LighthouseContext s, java.lang.String id)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

code_id

public static final java.lang.String code_id
See Also:
Constant Field Values
Constructor Detail

FormUtil

public FormUtil()
Method Detail

getObject

public static PersistentObject getObject(LighthouseContext s,
                                         java.lang.String typeName,
                                         java.lang.String id)
                                  throws WavesetException
Get an object from the repository, subject to authorization.

Throws:
WavesetException

getObjectRef

public static ObjectRef getObjectRef(LighthouseContext s,
                                     java.lang.String typeName,
                                     java.lang.String id)
                              throws WavesetException
Get an ObjectRef from the repository given the type and name or id, subject to authorization.

Throws:
WavesetException

getObjectRefList

public static java.util.List getObjectRefList(LighthouseContext s,
                                              java.lang.String typeName,
                                              java.util.List ids)
                                       throws WavesetException
Throws:
WavesetException

getMemberOrganization

public static java.lang.String getMemberOrganization(LighthouseContext s)
                                              throws WavesetException
Get the name of the first member object group for the administrator currently logged into the session.

This assumes the administrator controls the group of which they are a member, otherwise they won't be able to read themselves. Would be nicer to have an Administrator view that can be used to return information about the current admin.

Throws:
WavesetException

sort

public static java.util.List sort(java.util.List l)
Sort a List by its natural ordering and return it.

Parameters:
l - The List to sort.
Returns:
The sorted List.

getObjectNames

public static java.util.List getObjectNames(LighthouseContext s,
                                            java.lang.String typeName)
                                     throws WavesetException
Return a list of the names of objects if a given type to which the session owner has access.

Throws:
WavesetException

getObjectNames

public static java.util.List getObjectNames(LighthouseContext s,
                                            java.lang.String typeName,
                                            java.util.List current)
                                     throws WavesetException
Deprecated. use getObjectNames(LighthouseContext s, String typeName, Map options) instead

Return a list of the names of objects if a given type to which the session owner has access.

Throws:
WavesetException

getObjectNames

public static java.util.List getObjectNames(LighthouseContext s,
                                            java.lang.String typeName,
                                            java.util.List current,
                                            java.util.Map options)
                                     throws WavesetException
Deprecated. use getObjectNames(LighthouseContext s, String typeName, Map options) instead

Return a list of the names of objects if a given type to which the session owner has access.

Throws:
WavesetException

getObjectNames

public static java.util.List getObjectNames(LighthouseContext s,
                                            java.lang.String typeName,
                                            java.lang.String attrName,
                                            java.lang.String attrValue,
                                            java.util.List current)
                                     throws WavesetException
Deprecated. use getObjectNames(LighthouseContext s, String typeName, Map options) instead

Return a list of the names of objects if a given type to which the session owner has access.

Throws:
WavesetException

getObjectNames

public static java.util.List getObjectNames(LighthouseContext s,
                                            java.lang.String typeName,
                                            java.lang.String attrName,
                                            java.lang.String attrValue,
                                            java.util.List current,
                                            java.util.Map options)
                                     throws WavesetException
Deprecated. use getObjectNames(LighthouseContext s, String typeName, Map options) instead

Return a list of the names of objects if a given type to which the session owner has access.

Throws:
WavesetException

getObjectNames

public static java.util.List getObjectNames(LighthouseContext s,
                                            Type type,
                                            java.lang.String attrName,
                                            java.lang.String attrValue,
                                            java.util.List current)
                                     throws WavesetException
Deprecated. use getObjectNames(LighthouseContext s, String typeName, Map options) instead

Return a list of the names of objects if a given type to which the session owner has access.

Throws:
WavesetException

getObjectNames

public static java.util.List getObjectNames(LighthouseContext s,
                                            Type type,
                                            java.lang.String attrName,
                                            java.lang.String attrValue,
                                            java.util.List current,
                                            java.util.Map options)
                                     throws WavesetException
Deprecated. use getObjectNames(LighthouseContext s, String typeName, Map options) instead

Return a list of the names of objects if a given type to which the session owner has access.

Throws:
WavesetException

getObjectNames

public static java.util.List getObjectNames(LighthouseContext s,
                                            java.lang.String typeName,
                                            java.util.Map options)
                                     throws WavesetException
Returns a list of names of objects of a given type to which the session owner (subject) has access. In addition, a map of options can be specified to further filter the list of names returned. Supported options include: - "scopingOrg" - this options value should be the name of an organization indicating that the returned list should contain only names of the requested type that are "available to" organizations controlled by an AdminRole that controls the organization matching the value of this query option and is assigned to the current logged in user. a common case for this is when a user is assigned more than one AdminRole and you want to ensure that when creating or editing a user, the member organization of the user being created or edited determines what object names of the requested type are available for assignment. - "current" - a list of one or more currently selected applications - "conditions" - which can be specified in the following ways: * where the first entry is the name of a queryable attribute supported by this type of object and the second is the value an object of this type must have for the associated queryable attribute in order to be returned (the operator is assumed to be "equals"). If more than one attrname/value pairs are specified, they will be logically and'ed together. * as a list of AttributeCondition objects. For example MemberObjectGroups equals waveset.organization If more than one AttributeCondition is specified, they will be logically and'ed together.

Throws:
WavesetException

getObjectDisplayNames

public static java.util.List getObjectDisplayNames(LighthouseContext s,
                                                   java.lang.String typeName,
                                                   java.util.Map options)
                                            throws WavesetException
Returns a list of display names of objects of a given type to which the session owner (subject) has access. This is similar to getObjectNames except it will return the display names for the object type specified. For all object types other than ObjectGroup, the display name is the same as the name. However, for type ObjectGroup, the display name returned will be either the short org name or the full path name of the org depending on whether the pathPrefixes option is set to true or false. This method is provided as a convienent wrapper of getObjectNames and getOrganizationsDisplayNames for form fields where the type argument is variable.

In addition, a map of options can be specified to further filter the list of names returned. Supported options include: - "scopingOrg" - this options value should be the name of an organization indicating that the returned list should contain only names of the requested type that are "available to" organizations controlled by an AdminRole that controls the organization matching the value of this query option and is assigned to the current logged in user. a common case for this is when a user is assigned more than one AdminRole and you want to ensure that when creating or editing a user, the member organization of the user being created or edited determines what object names of the requested type are available for assignment. - "current" - a list of one or more currently selected applications - "conditions" - which can be specified in the following ways: * where the first entry is the name of a queryable attribute supported by this type of object and the second is the value an object of this type must have for the associated queryable attribute in order to be returned (the operator is assumed to be "equals"). If more than one attrname/value pairs are specified, they will be logically and'ed together. * as a list of AttributeCondition objects. For example MemberObjectGroups equals waveset.organization If more than one AttributeCondition is specified, they will be logically and'ed together. When typeName is "ObjectGroup" the following options are also supported: - "excluded" - a list of Organization names to exclude from the list returned. - "current" - a list of Organizations name to add to the list returned if not already there. - "filterVirtual" - if "true", remove any virtual Organizations from the returned list. - "pathPrefixes" - if "true", return Organizations full path names. If null or "false, return Organizations short display names.

Throws:
WavesetException

getPolicies

public static java.util.List getPolicies(LighthouseContext s)
                                  throws WavesetException
Throws:
WavesetException

getPolicies

public static java.util.List getPolicies(LighthouseContext s,
                                         java.lang.String currentPolicy)
                                  throws WavesetException
Special call to get the policies and if the current policy is not on the list, add it to the list.

This is for the case of a resource administrator who does not have access to the policy referred to by the current resource.

jsl - this feels like it needs to be generalized

Throws:
WavesetException

getPolicies

public static java.util.List getPolicies(LighthouseContext s,
                                         java.lang.String type,
                                         java.lang.String currentPolicy)
                                  throws WavesetException
Return a string array of policy names of the specified type. If type is null, return all policy names

Throws:
WavesetException

getPolicies

public static java.util.List getPolicies(LighthouseContext s,
                                         java.util.Map options)
                                  throws WavesetException
Return a string array of policy names of the specified type. If type is null, return all policy names. In addition, a map of options can be specified to further filter the list of names returned. Supported options include: - "scopingOrg" - this options value should be the name of an organization indicating that the returned list should contain only names of the requested type that are "available to" organizations controlled by an AdminRole that controls the organization matching the value of this query option and is assigned to the current logged in user. a common case for this is when a user is assigned more than one AdminRole and you want to ensure that when creating or editing a user, the member organization of the user being created or edited determines what object names of the requested type are available for assignment. - "current" - a list of one or more currently selected applications - "conditions" - which can be specified in the following ways: * where the first entry is the name of a queryable attribute supported by this type of object and the second is the value an object of this type must have for the associated queryable attribute in order to be returned (the operator is assumed to be "equals"). If more than one attrname/value pairs are specified, they will be logically and'ed together. * as a list of AttributeCondition objects. For example MemberObjectGroups equals waveset.organization If more than one AttributeCondition is specified, they will be logically and'ed together. - "typeString" - specifies the specific type of policy (e.g. StringQualityPolicy, Lighthouse Account, etc.)

Throws:
WavesetException

checkStringQualityPolicy

public static java.lang.Object checkStringQualityPolicy(LighthouseContext s,
                                                        java.lang.String policy,
                                                        java.lang.Object value,
                                                        java.util.Map map,
                                                        java.util.List pwdhistory,
                                                        java.lang.String owner)
                                                 throws WavesetException
Check string value against string policy Return true if string passes policy tests or error msg(s) if fails Add option returnNull=true to map and a success will return null.

Parameters:
s - - a LighthouseContext
policy - - policy name (required)
value - - string value to check (required)
map - - map of 'must not contain' data (optional) and/or use returnNull=true to return NULL when pwd passes policy check
pwdhistory - - list of user's password history (optional)
owner - - user whose string value is being checked (required)
Returns:
object - null if passes, error msg if fails
Throws:
WavesetException

getUsers

public static java.util.List getUsers(LighthouseContext s)
                               throws WavesetException
Returns a list of users in the authorization scope of the specified lighthouse context. The list will include all users with or without capabilities assigned (e.g. admins).

Throws:
WavesetException

getUsers

public static java.util.List getUsers(LighthouseContext s,
                                      java.util.Map options)
                               throws WavesetException
Returns a list of users in the authorization scope of the specified lighthouse context. By default, the list will include all users with or without capabilities assigned (e.g. admins). In addition, a map of options can be specified to further filter the list returned. Supported options include: - "exclude" this options value can be either "administrators" or "endUsers". If the value is "administrators" the list of users returned will not contain any users that are either directly or indirectly (via adminroles) assigned one or more capabilities and control one or more organizations. If the value is "endUsers" the list returned will only include users directly or indirectly assigned one or more capabilities and controlled organizations. Note that this option is a convienence since the same filter can be applied using the "conditions" options. - "scopingOrg" - this options value should be the name of an organization indicating that the returned list should contain only names of the requested type that are "available to" organizations controlled by an AdminRole that controls the organization matching the value of this query option and is assigned to the current logged in user. a common case for this is when a user is assigned more than one AdminRole and you want to ensure that when creating or editing a user, the member organization of the user being created or edited determines what object names of the requested type are available for assignment. - "current" - a list of one or more currently selected users - "conditions" - which can be specified in the following ways: * where the first entry is the name of a queryable attribute supported by this type of object and the second is the value an object of this type must have for the associated queryable attribute in order to be returned (the operator is assumed to be "equals"). If more than one attrname/value pairs are specified, they will be logically and'ed together. * as a list of AttributeCondition objects. For example MemberObjectGroups equals waveset.organization If more than one AttributeCondition is specified, they will be logically and'ed together. The set of allowed queryable attributes includes all those supported by User (e.g. name, firstname, lastname, role, user_resources, etc.), plus the following pseudo-attributes: - "userType" - allowed values include "administrator" and "approver" - "similarTo" - returns users that control at least one of the organizations controlled by the user specified as the value of the attribute, where value is expected to be a user name.

Throws:
WavesetException

getAdministrators

public static java.util.List getAdministrators(LighthouseContext lc)
                                        throws WavesetException
Return a string array of Administrator names

Throws:
WavesetException

getAdministrators

public static java.util.List getAdministrators(Session s,
                                               java.util.Map options)
                                        throws WavesetException
Deprecated. - replaced by getUsers(LighthouseContext, Map)
specifying the "userType" equals "administrator" option as follows:

 <invoke class='com.waveset.ui.FormUtil' name='getUsers'>
    <ref>:display.session</ref>
    <map>
      <s>conditions</s>
      <list>
        <new class='com.waveset.object.AttributeCondition'>
          <s>userType</s>
          <s>equals</s>
          <s>administrator</s>
        </new>
      </list>
    </map>
 </invoke>

Return a list of administrators. The value of the attribute specified in the AdminDisplayAttribute element of UserUIConfig is used instead of the accountId. The attribute specified in AdminDisplayAttribute must be a SummaryAttribute

Throws:
WavesetException

getAdministrators

public static java.util.List getAdministrators(Session s,
                                               java.util.List existing)
                                        throws WavesetException
Deprecated. - replaced by getUsers(LighthouseContext, Map)
specifying the "userType" equals "administrator" option and "current" option to specify the list of current users instead of the "existing" param.

 <invoke class='com.waveset.ui.FormUtil' name='getUsers'>
    <ref>:display.session</ref>
    <map>
      <s>conditions</s>
      <list>
        <new class='com.waveset.object.AttributeCondition'>
          <s>userType</s>
          <s>equals</s>
          <s>administrator</s>
        </new>
      </list>
      <s>current</s>
      <ref>existing</ref>
    </map>
 </invoke>

Return a list of administrators. The value of the attribute specified in the AdminDisplayAttribute element of UserUIConfig is used instead of the accountId.

Parameters:
existing - - an existing list of admins to ensure there are no duplicates.
Throws:
WavesetException

getApprovers

public static java.util.List getApprovers(Session s)
                                   throws WavesetException
Deprecated. - replaced by getUsers(LighthouseContext, Map)
specifying the "userType" equals "approver" option as follows:

 <invoke class='com.waveset.ui.FormUtil' name='getUsers'>
    <ref>:display.session</ref>
    <map>
      <s>conditions</s>
      <list>
        <new class='com.waveset.object.AttributeCondition'>
          <s>userType</s>
          <s>equals</s>
          <s>approver</s>
        </new>
      </list>
    </map>
 </invoke>

Return a list of approvers. The value of the attribute specified in the AdminDisplayAttribute element of UserUIConfig is used instead of the accountId.

Throws:
WavesetException

getApprovers

public static java.util.List getApprovers(Session s,
                                          java.util.List existing)
                                   throws WavesetException
Deprecated. - replaced by getUsers(LighthouseContext, Map)
specifying the "userType" equals "approver" option and "current" option to specify the list of current users instead of the "existing" param.

 <invoke class='com.waveset.ui.FormUtil' name='getUsers'>
    <ref>:display.session</ref>
    <map>
      <s>conditions</s>
      <list>
        <new class='com.waveset.object.AttributeCondition'>
          <s>userType</s>
          <s>equals</s>
          <s>approver</s>
        </new>
      </list>
      <s>current</s>
      <ref>existing</ref>
    </map>
 </invoke>

Return a list of approvers. The value of the attribute specified in the AdminDisplayAttribute element of UserUIConfig is used instead of the accountId.

Parameters:
existing - - an existing list of admins to ensure there are no duplicates.
Throws:
WavesetException

getSimilarApprovers

public static java.util.List getSimilarApprovers(Session s)
                                          throws WavesetException
Deprecated. - replaced by getUsers(LighthouseContext, Map)
specifying the "userType" equals "administrator" option and "similarTo" option with a value of the current user's name

 <invoke class='com.waveset.ui.FormUtil' name='getUsers'>
    <ref>:display.session</ref>
    <map>
      <s>conditions</s>
      <list>
        <new class='com.waveset.object.AttributeCondition'>
          <s>userType</s>
          <s>equals</s>
          <s>administrator</s>
        </new>
        <new class='com.waveset.object.AttributeCondition'>
          <s>similarTo</s>
          <s>equals</s>
          <invoke name='getUser'>
            <ref>:display.session</ref>
          </invoke>
        </new>
      </list>
    </map>
 </invoke>

Return a list of approvers that control at least the object groups that the current admin controls.

Throws:
WavesetException

getSimilarApprovers

public static java.util.List getSimilarApprovers(Session s,
                                                 java.lang.String admin)
                                          throws WavesetException
Deprecated. - replaced by getUsers(LighthouseContext, Map)
specifying the "userType" equals "administrator" option and "similarTo" option with a value of the current user's name

 <invoke class='com.waveset.ui.FormUtil' name='getUsers'>
    <ref>:display.session</ref>
    <map>
      <s>conditions</s>
      <list>
        <new class='com.waveset.object.AttributeCondition'>
          <s>userType</s>
          <s>equals</s>
          <s>administrator</s>
        </new>
        <new class='com.waveset.object.AttributeCondition'>
          <s>similarTo</s>
          <s>equals</s>
          <ref>admin</ref>
        </new>
      </list>
    </map>
 </invoke>

Like getApprovers - this lists all administrators that control at least the object groups that the specified administrator controls. Any admin can be passed in, but it must be either the currently authenticated admin or one in a group that he controls. The names returned may not be accessible to the caller as they come from objects resolved out of the server cache.

Throws:
WavesetException

getApproverNames

public static java.util.List getApproverNames(Session s)
                                       throws WavesetException
Deprecated. - replaced by #getUsers(Session, Map)
specifying the "userType" equals "approver" option as follows:

 <invoke class='com.waveset.ui.FormUtil' name='getUsers'>
    <ref>:display.session</ref>
    <map>
      <s>conditions</s>
      <list>
        <new class='com.waveset.object.AttributeCondition'>
          <s>userType</s>
          <s>equals</s>
          <s>approver</s>
        </new>
      </list>
    </map>
 </invoke>

Return a list of the names of approvers

Throws:
WavesetException

getApproverNames

public static java.util.List getApproverNames(Session s,
                                              java.util.List existing)
                                       throws WavesetException
Deprecated. - replaced by getUsers(LighthouseContext, Map)
specifying the "userType" equals "approver" option and "current" option to specify the list of current users instead of the "existing" param.

 <invoke class='com.waveset.ui.FormUtil' name='getUsers'>
    <ref>:display.session</ref>
    <map>
      <s>conditions</s>
      <list>
        <new class='com.waveset.object.AttributeCondition'>
          <s>userType</s>
          <s>equals</s>
          <s>approver</s>
        </new>
      </list>
      <s>current</s>
      <ref>existing</ref>
    </map>
 </invoke>

Throws:
WavesetException

getSimilarApproverNames

public static java.util.List getSimilarApproverNames(Session s)
                                              throws WavesetException
Deprecated. - replaced by getUsers(LighthouseContext, Map)
specifying the "userType" equals "administrator" option and "similarTo" option with a value of the current user's name

 <invoke class='com.waveset.ui.FormUtil' name='getUsers'>
    <ref>:display.session</ref>
    <map>
      <s>conditions</s>
      <list>
        <new class='com.waveset.object.AttributeCondition'>
          <s>userType</s>
          <s>equals</s>
          <s>administrator</s>
        </new>
        <new class='com.waveset.object.AttributeCondition'>
          <s>similarTo</s>
          <s>equals</s>
          <invoke name='getUser'>
            <ref>:display.session</ref>
          </invoke>
        </new>
      </list>
    </map>
 </invoke>

Return a list of the names of approvers that control at least the object groups that the current admin controls.

Throws:
WavesetException

getSimilarApproverNames

public static java.util.List getSimilarApproverNames(Session s,
                                                     java.lang.String admin)
                                              throws WavesetException
Deprecated. - replaced by getUsers(LighthouseContext, Map)
specifying the "userType" equals "administrator" option and "similarTo" option with a value of the current user's name

 <invoke class='com.waveset.ui.FormUtil' name='getUsers'>
    <ref>:display.session</ref>
    <map>
      <s>conditions</s>
      <list>
        <new class='com.waveset.object.AttributeCondition'>
          <s>userType</s>
          <s>equals</s>
          <s>administrator</s>
        </new>
        <new class='com.waveset.object.AttributeCondition'>
          <s>similarTo</s>
          <s>equals</s>
          <ref>admin</ref>
        </new>
      </list>
    </map>
 </invoke>

Like listApprovers, below - this lists all administrators that control at least the object groups that the specified administrator controls. Any admin can be passed in, but it must be either the currently authenticated admin or one in a group that he controls. The names returned may not be accessible to the caller as they come from objects resolved out of the server cache.

Throws:
WavesetException

getRoles

public static java.util.List getRoles(LighthouseContext s)
                               throws WavesetException
Throws:
WavesetException

getRoles

public static java.util.List getRoles(LighthouseContext s,
                                      java.lang.String current)
                               throws WavesetException
This variant allows a specific name to be included in the returned list. Used to ensure that the current value of a role may continue to be assigned even though the current admin may not have access to that role.

Throws:
WavesetException

getRoles

public static java.util.List getRoles(LighthouseContext s,
                                      java.util.List current)
                               throws WavesetException
This variant allows a list of names to be included in the returned list. Used to ensure that the current value of a role may continue to be assigned even though the current admin may not have access to those roles.

Throws:
WavesetException

getRoles

public static java.util.List getRoles(LighthouseContext s,
                                      java.util.Map options)
                               throws WavesetException
Returns a list of roles in the authorization scope of the specified lighthouse context. In addition, a map of options can be specified to further filter the list returned. Supported options include: - "scopingOrg" - this options value should be the name of an organization indicating that the returned list should contain only names of the requested type that are "available to" organizations controlled by an AdminRole that controls the organization matching the value of this query option and is assigned to the current logged in user. a common case for this is when a user is assigned more than one AdminRole and you want to ensure that when creating or editing a user, the member organization of the user being created or edited determines what object names of the requested type are available for assignment. - "current" - a list of one or more currently selected roles - "conditions" - which can be specified in the following ways: * where the first entry is the name of a queryable attribute supported by this type of object and the second is the value an object of this type must have for the associated queryable attribute in order to be returned (the operator is assumed to be "equals"). If more than one attrname/value pairs are specified, they will be logically and'ed together. * as a list of AttributeCondition objects. For example MemberObjectGroups equals waveset.organization If more than one AttributeCondition is specified, they will be logically and'ed together.

Throws:
WavesetException

getApplications

public static java.util.List getApplications(LighthouseContext s)
                                      throws WavesetException
Deprecated. use getApplications(LighthouseContext s, Map options) instead

Throws:
WavesetException

getApplications

public static java.util.List getApplications(LighthouseContext s,
                                             java.util.List current)
                                      throws WavesetException
Deprecated. use getApplications(LighthouseContext s, Map options) instead

Throws:
WavesetException

getApplications

public static java.util.List getApplications(LighthouseContext s,
                                             java.util.Map options)
                                      throws WavesetException
Returns a list of applications in the authorization scope of the specified lighthouse context. In addition, a map of options can be specified to further filter the list returned. Supported options include: - "scopingOrg" - this options value should be the name of an organization indicating that the returned list should contain only names of the requested type that are "available to" organizations controlled by an AdminRole that controls the organization matching the value of this query option and is assigned to the current logged in user. a common case for this is when a user is assigned more than one AdminRole and you want to ensure that when creating or editing a user, the member organization of the user being created or edited determines what object names of the requested type are available for assignment. - "current" - a list of one or more currently selected applications - "conditions" - which can be specified in the following ways: * where the first entry is the name of a queryable attribute supported by this type of object and the second is the value an object of this type must have for the associated queryable attribute in order to be returned (the operator is assumed to be "equals"). If more than one attrname/value pairs are specified, they will be logically and'ed together. * as a list of AttributeCondition objects. For example MemberObjectGroups equals waveset.organization If more than one AttributeCondition is specified, they will be logically and'ed together.

Throws:
WavesetException

getUnassignedApplications

public static java.util.List getUnassignedApplications(LighthouseContext s,
                                                       java.lang.String roleName,
                                                       java.util.List current)
                                                throws WavesetException
Build a list of names suitable for the "private applications" of a user. This is the list of all accessible applications minus the ones already assigned to the user through their role. !! This will need to flatten the Application hierarchy like we do for the Resource hierarchy. PWD: we need to add in private applications to the available list.

Throws:
WavesetException

getUnassignedApplications

public static java.util.List getUnassignedApplications(LighthouseContext s,
                                                       java.lang.String roleName)
                                                throws WavesetException
Throws:
WavesetException

getUnassignedApplications

public static java.util.List getUnassignedApplications(LighthouseContext s,
                                                       java.util.List roleNames,
                                                       java.util.List current)
                                                throws WavesetException
Throws:
WavesetException

getUnassignedApplications

public static java.util.List getUnassignedApplications(LighthouseContext s,
                                                       java.util.List roleNames,
                                                       java.util.Map options)
                                                throws WavesetException
Throws:
WavesetException

getUnassignedApplications

public static java.util.List getUnassignedApplications(LighthouseContext s,
                                                       java.util.Map options)
                                                throws WavesetException
Build a list of application names suitable for the "private applications" of a user. Takes the following options: current: list of current application names. The returned list will always contain each of these applications regardless of the other options. currentRoles: list of current role names. The returned list will NOT contain any applications that is assigned via one of these roles UNLESS that application name is on the current list in which case we are forced to add it back on. conditions: which can be specified in the following ways: * where the first entry is the name of a queryable attribute supported by this type of object and the second is the value an object of this type must have for the associated queryable attribute in order to be returned (the operator is assumed to be "equals"). If more than one attrname/value pairs are specified, they will be logically and'ed together. * as a list of AttributeCondition objects. For example MemberObjectGroups equals waveset.organization If more than one AttributeCondition is specified, they will be logically and'ed together.

Throws:
WavesetException

getPrivateApplications

public static java.util.List getPrivateApplications(LighthouseContext s,
                                                    java.lang.String roleName)
                                             throws WavesetException
This was the original name, keep for backward compatibility.

Throws:
WavesetException

getResources

public static java.util.List getResources(LighthouseContext s)
                                   throws WavesetException
Throws:
WavesetException

getResources

public static java.util.List getResources(LighthouseContext s,
                                          java.util.List current)
                                   throws WavesetException
Throws:
WavesetException

getResources

public static java.util.List getResources(LighthouseContext s,
                                          java.lang.String matchType,
                                          java.lang.String value)
                                   throws WavesetException
Build a list of the names of resources that match a particular type (like LDAP).

Throws:
WavesetException

getResources

public static java.util.List getResources(LighthouseContext s,
                                          java.lang.String matchType,
                                          java.lang.String value,
                                          java.util.List current)
                                   throws WavesetException
Throws:
WavesetException

getResources

public static java.util.List getResources(LighthouseContext s,
                                          java.util.Map options)
                                   throws WavesetException
Returns a list of resources in the authorization scope of the specified lighthouse context. In addition, a map of options can be specified to further filter the list returned. Supported options include: - "scopingOrg" - this options value should be the name of an organization indicating that the returned list should contain only names of the requested type that are "available to" organizations controlled by an AdminRole that controls the organization matching the value of this query option and is assigned to the current logged in user. a common case for this is when a user is assigned more than one AdminRole and you want to ensure that when creating or editing a user, the member organization of the user being created or edited determines what object names of the requested type are available for assignment. - "current" - a list of one or more currently selected resources - "conditions" - which can be specified in the following ways: * where the first entry is the name of a queryable attribute supported by this type of object and the second is the value an object of this type must have for the associated queryable attribute in order to be returned (the operator is assumed to be "equals"). If more than one attrname/value pairs are specified, they will be logically and'ed together. * as a list of AttributeCondition objects. For example MemberObjectGroups equals waveset.organization If more than one AttributeCondition is specified, they will be logically and'ed together.

Throws:
WavesetException

getResourcesSupportingContainerObjectTypes

public static java.util.List getResourcesSupportingContainerObjectTypes(LighthouseContext s)
                                                                 throws WavesetException
Throws:
WavesetException

getResourcesSupportingContainerObjectTypes

public static java.util.List getResourcesSupportingContainerObjectTypes(LighthouseContext s,
                                                                        java.util.Map options)
                                                                 throws WavesetException
Throws:
WavesetException

getResourcesSupportingObjectTypes

public static java.util.List getResourcesSupportingObjectTypes(LighthouseContext s,
                                                               java.util.List objectTypes)
                                                        throws WavesetException
Throws:
WavesetException

getResourcesSupportingObjectTypes

public static java.util.List getResourcesSupportingObjectTypes(LighthouseContext s,
                                                               java.util.List objectTypes,
                                                               java.util.Map options)
                                                        throws WavesetException
Throws:
WavesetException

getResourcesSupportingObjectTypes

public static java.util.List getResourcesSupportingObjectTypes(LighthouseContext s,
                                                               java.util.List objectTypes,
                                                               java.util.List current)
                                                        throws WavesetException
Throws:
WavesetException

getResourcesSupportingObjectTypes

public static java.util.List getResourcesSupportingObjectTypes(LighthouseContext s,
                                                               java.util.List objectTypes,
                                                               java.util.List current,
                                                               java.util.Map options)
                                                        throws WavesetException
Throws:
WavesetException

getUnassignedResources

public static java.util.List getUnassignedResources(LighthouseContext s,
                                                    java.lang.String roleName,
                                                    java.util.List current)
                                             throws WavesetException
Deprecated. use getUnassignedResources(LighthouseContext s, Map options) instead

Throws:
WavesetException

getUnassignedResources

public static java.util.List getUnassignedResources(LighthouseContext s,
                                                    java.util.List roleNames,
                                                    java.util.List current)
                                             throws WavesetException
Deprecated. use getUnassignedResources(LighthouseContext s, Map options) instead

Throws:
WavesetException

getUnassignedResources

public static java.util.List getUnassignedResources(LighthouseContext s,
                                                    java.lang.String roleName)
                                             throws WavesetException
Deprecated. use getUnassignedResources(LighthouseContext s, Map options) instead

Throws:
WavesetException

getUnassignedResources

public static java.util.List getUnassignedResources(LighthouseContext s,
                                                    java.util.Map options)
                                             throws WavesetException
Build a list of resource names suitable for the "private resources" of a user. Takes the following options: current: list of current resource names. The returned list will always contain each of these resources regardless of the other options. currentRoles: list of current role names. The returned list will NOT contain any resource that is assigned via one of these roles UNLESS that resource name is on the current list in which case we are forced to add it back on. currentResourceGroups: list of current resource group names. The returned list will NOT contain any resource that is assigned via one of these resource gruops UNLESS that resource name is on the current list in which case we are forced to add it back on. availableToOrgScope: list of organization names (or paths or displayNames if unique). Only resources that are available to organizations on this list will be returned (except for resources on the current list which are always returned). conditions: which can be specified in the following ways: * where the first entry is the name of a queryable attribute supported by this type of object and the second is the value an object of this type must have for the associated queryable attribute in order to be returned (the operator is assumed to be "equals"). If more than one attrname/value pairs are specified, they will be logically and'ed together. * as a list of AttributeCondition objects. For example MemberObjectGroups equals waveset.organization If more than one AttributeCondition is specified, they will be logically and'ed together.

Throws:
WavesetException

getPrivateResources

public static java.util.List getPrivateResources(LighthouseContext s,
                                                 java.lang.String roleName)
                                          throws WavesetException
This was the original name, keep it around for backward compatibility.

Throws:
WavesetException

getOrganizations

public static java.util.List getOrganizations(LighthouseContext s)
                                       throws WavesetException
Deprecated. Use getOrganizationsDisplayNames(LighthouseContext s, Map options) instead

Throws:
WavesetException

getOrganizationsWithPrefixes

public static java.util.List getOrganizationsWithPrefixes(LighthouseContext s)
                                                   throws WavesetException
Deprecated. Use getOrganizationsDisplayNames(LighthouseContext s, Map options) instead

Throws:
WavesetException

getOrganizations

public static java.util.List getOrganizations(LighthouseContext s,
                                              java.util.List current)
                                       throws WavesetException
Deprecated. Use getOrganizationsDisplayNames(LighthouseContext s, Map options) instead

Throws:
WavesetException

getOrganizationsWithPrefixes

public static java.util.List getOrganizationsWithPrefixes(LighthouseContext s,
                                                          java.util.List current)
                                                   throws WavesetException
Deprecated. Use getOrganizationsDisplayNames(LighthouseContext s, Map options) instead

Throws:
WavesetException

getOrganizations

public static java.util.List getOrganizations(LighthouseContext s,
                                              boolean pathPrefixes,
                                              java.util.List current)
                                       throws WavesetException
Deprecated. Use getOrganizationsDisplayNames(LighthouseContext s, Map options) instead

Throws:
WavesetException

getOrganizations

public static java.util.List getOrganizations(LighthouseContext s,
                                              boolean pathPrefixes)
                                       throws WavesetException
Deprecated. Use getOrganizationsDisplayNames(LighthouseContext s, Map options) instead

Throws:
WavesetException

getOrganizationsDisplayNames

public static java.util.List getOrganizationsDisplayNames(LighthouseContext s)
                                                   throws WavesetException
Short cut for calling getOrganizationsDisplayNames(LighthouseContext s, Map options) with no options.

Throws:
WavesetException

getOrganizationsDisplayNamesWithPrefixes

public static java.util.List getOrganizationsDisplayNamesWithPrefixes(LighthouseContext s)
                                                               throws WavesetException
Deprecated. Use getOrganizationsDisplayNames(LighthouseContext s, Map options) instead

Throws:
WavesetException

getOrganizationsDisplayNames

public static java.util.List getOrganizationsDisplayNames(LighthouseContext s,
                                                          java.util.List current)
                                                   throws WavesetException
Deprecated. Use getOrganizationsDisplayNames(LighthouseContext s, Map options) instead

Throws:
WavesetException

getOrganizationsDisplayNamesWithPrefixes

public static java.util.List getOrganizationsDisplayNamesWithPrefixes(LighthouseContext s,
                                                                      java.util.List current)
                                                               throws WavesetException
Deprecated. Use getOrganizationsDisplayNames(LighthouseContext s, Map options) instead

Throws:
WavesetException

getOrganizationsDisplayNames

public static java.util.List getOrganizationsDisplayNames(LighthouseContext s,
                                                          boolean pathPrefixes,
                                                          java.util.List current)
                                                   throws WavesetException
Deprecated. Use getOrganizationsDisplayNames(LighthouseContext s, Map options) instead

Throws:
WavesetException

getOrganizationsDisplayNames

public static java.util.List getOrganizationsDisplayNames(LighthouseContext s,
                                                          java.util.Map options)
                                                   throws WavesetException
Returns:
a list of organization pathnames or displaynames that may be assigned to an object. This should be used by all forms that need organization select and multi-select list. - "excluded" - a list of Organization names to exclude from the list returned. - "current" - a list of Organizations name to add to the list returned if not already there. - "filterVirtual" - if "true", remove any virtual Organizations from the returned list. - "pathPrefixes" - if "true", return Organizations full path names. If null or "false, return Organizations short display names.
Throws:
WavesetException

getOrganizationsDisplayNames

public static java.util.List getOrganizationsDisplayNames(LighthouseContext s,
                                                          boolean pathPrefixes)
                                                   throws WavesetException
Deprecated. Use getOrganizationsDisplayNames(LighthouseContext s, Map options) instead

Throws:
WavesetException

getOrganizationDisplayableNameByUserId

public static java.lang.String getOrganizationDisplayableNameByUserId(LighthouseContext s,
                                                                      java.util.List userIds)
                                                               throws WavesetException
Return the displayableName for the common objectGroup which the userIds belong in.

Parameters:
s -
userIds -
Returns:
the displayableName of the single object group which the userd belong. Returns null if any of the userId is not a valid user id, or if any or all users belong to multiple object groups
Throws:
WavesetException

getOrganizationsDisplayNamesWithRight

public static java.util.List getOrganizationsDisplayNamesWithRight(LighthouseContext s,
                                                                   java.lang.String type,
                                                                   java.lang.String targetRight)
                                                            throws WavesetException
Calls #getOrganizationsDisplayNamesWithRights(LighthouseContext, String, List, Map) with targetRight wrapped into a list and null options.

Parameters:
s -
type -
targetRight -
Returns:
a list containing the display names of organizations.
Throws:
WavesetException

getOrganizationsDisplayNamesWithRight

public static java.util.List getOrganizationsDisplayNamesWithRight(LighthouseContext s,
                                                                   java.lang.String type,
                                                                   java.lang.String targetRight,
                                                                   java.util.Map options)
                                                            throws WavesetException
Calls #getOrganizationsDisplayNamesWithRights(LighthouseContext, String, List, Map) with targetRight wrapped into a list.

Parameters:
s -
type -
targetRight -
options -
Returns:
a list containing the display names of organizations.
Throws:
WavesetException

getOrganizationsDisplayNamesWithRights

public static java.util.List getOrganizationsDisplayNamesWithRights(LighthouseContext s,
                                                                    java.lang.String type,
                                                                    java.util.List targetRights)
                                                             throws WavesetException
Calls #getOrganizationsDisplayNamesWithRights(LighthouseContext, String, List, Map) with null options.

Parameters:
s -
type -
targetRights -
Returns:
a list containing the display names of organizations.
Throws:
WavesetException

getOrganizationsDisplayNamesWithRights

public static java.util.List getOrganizationsDisplayNamesWithRights(LighthouseContext s,
                                                                    java.lang.String type,
                                                                    java.util.List targetRights,
                                                                    java.util.Map options)
                                                             throws WavesetException
Parameters:
s - Context used to retrieve the organization names.
type - The object type on which the targetRights are desired.
targetRights - The rights on the object type that are desired.
options - Contains options to control what is returned. These options are passed into the underlying listObjects() call. In addition to options valid for listObjects(), the following options are also available:
pathPrefixes
If "true", then the organization names are returned using the path syntax, e.g. Top:Org1:OrgB. Otherwise, the display names are returned.
includeId
If "true", the list is returned in "map list" format where the organization (ObjectGroup) object ids are followed by the organization names, i.e. the list would contain the id of org1 followed by the name of org1 followed by the id of org2 followed by the name of org2, etc.
returnMapList
If "true", the list is return in "map list" format. This option is ignored if the includeId option is set to "true". The organization display name will be followed by either the display name (again) or the full path name (if the pathPrefixes option is set to "true").
Returns:
A list of organization names for which the subject has the specified Rights on the specified object type. Depending on the options specified, the list can just be a simple list or it can be a "map list" suitable for use in setting the valueMap property of the Select HTML component.
Throws:
WavesetException

getOrgPath

public static java.lang.String getOrgPath(ObjectGroup group)
                                   throws WavesetException
Throws:
WavesetException

stripOrgPath

public static java.lang.String stripOrgPath(java.lang.String path)
Given an organization name in "path" form, remove the path prefix.


getUnassignedOrganizations

public static java.util.List getUnassignedOrganizations(LighthouseContext s,
                                                        java.util.List current)
                                                 throws WavesetException
Deprecated. - use getOrganizationsDisplayNames(LighthouseContext s, Map options) instead.

Throws:
WavesetException

getUnassignedOrganizations

public static java.util.List getUnassignedOrganizations(LighthouseContext s)
                                                 throws WavesetException
Deprecated. - use getOrganizationsDisplayNames(LighthouseContext s, Map options) instead.

Throws:
WavesetException

getUnassignedOrganizationsWithPrefixes

public static java.util.List getUnassignedOrganizationsWithPrefixes(LighthouseContext s,
                                                                    java.util.List current)
                                                             throws WavesetException
Deprecated. - use getOrganizationsDisplayNames(LighthouseContext s, Map options) instead.

Throws:
WavesetException

getUnassignedOrganizationsWithPrefixes

public static java.util.List getUnassignedOrganizationsWithPrefixes(LighthouseContext s)
                                                             throws WavesetException
Deprecated. - use getOrganizationsDisplayNames(LighthouseContext s, Map options) instead.

Throws:
WavesetException

getUnassignedOrganizationsDisplayNames

public static java.util.List getUnassignedOrganizationsDisplayNames(LighthouseContext s,
                                                                    java.util.List current)
                                                             throws WavesetException
Deprecated. - use getOrganizationsDisplayNames(LighthouseContext s, Map options) instead.

Throws:
WavesetException

getUnassignedOrganizationsDisplayNames

public static java.util.List getUnassignedOrganizationsDisplayNames(LighthouseContext s)
                                                             throws WavesetException
Deprecated. - use getOrganizationsDisplayNames(LighthouseContext s, Map options) instead.

Throws:
WavesetException

getUnassignedOrganizationsDisplayNamesWithPrefixes

public static java.util.List getUnassignedOrganizationsDisplayNamesWithPrefixes(LighthouseContext s,
                                                                                java.util.List current)
                                                                         throws WavesetException
Deprecated. - use getOrganizationsDisplayNames(LighthouseContext s, Map options) instead.

Throws:
WavesetException

getUnassignedOrganizationsDisplayNamesWithPrefixes

public static java.util.List getUnassignedOrganizationsDisplayNamesWithPrefixes(LighthouseContext s)
                                                                         throws WavesetException
Deprecated. - use getOrganizationsDisplayNames(LighthouseContext s, Map options) instead.

Throws:
WavesetException

getUnassignedOrganizationsDisplayNames

public static java.util.List getUnassignedOrganizationsDisplayNames(LighthouseContext s,
                                                                    java.util.Map options)
                                                             throws WavesetException
Deprecated. Use getOrganizationsDisplayNames(LighthouseContext s, Map options) instead.

Build a list of org names suitable for the controlled orgs of an administrator. This will return a list of org name, scoped org path pairs suitable for use as a valueMap in form select and multiselect fields.

Throws:
WavesetException

getUnassignedCapabilities

public static java.util.List getUnassignedCapabilities(LighthouseContext s)
                                                throws WavesetException
Throws:
WavesetException

getSubordinates

public static java.util.List getSubordinates(LighthouseContext s,
                                             java.lang.String manager,
                                             java.util.Map options)
                                      throws WavesetException
Get the managerial subordinates of a user.

Parameters:
s - the LighthouseContext
manager - the manager whose subordinates are being requested
options -
  • firstlevel -- the first organizational level to include in the result, 0 means direct reports
  • lastLevel -- the last organizational level to include in the result, -1 means all levels
  • conditions -- an optional map of user attribute conditions which can be used to further filter the list of user names returned.
Returns:
a sorted list of subordinates
Throws:
WavesetException

getAdminRoles

public static java.util.List getAdminRoles(LighthouseContext s,
                                           java.util.Map options)
                                    throws WavesetException
Returns a list of capabilities in the authorization scope of the specified lighthouse context. In addition, a map of options can be specified to further filter the list returned. Supported options include: - "scopingOrg" - this options value should be the name of an organization indicating that the returned list should contain only names of the requested type that are "available to" organizations controlled by an AdminRole that controls the organization matching the value of this query option and is assigned to the current logged in user. a common case for this is when a user is assigned more than one AdminRole and you want to ensure that when creating or editing a user, the member organization of the user being created or edited determines what object names of the requested type are available for assignment. - "current" - a list of one or more currently selected capabilities - "conditions" - which can be specified in the following ways: * where the first entry is the name of a queryable attribute supported by this type of object and the second is the value an object of this type must have for the associated queryable attribute in order to be returned (the operator is assumed to be "equals"). If more than one attrname/value pairs are specified, they will be logically and'ed together. * as a list of AttributeCondition objects. For example MemberObjectGroups equals waveset.organization If more than one AttributeCondition is specified, they will be logically and'ed together. - "onlyAssignedToCurrentSubject" which, if true, removes any capabilities from the returned list that are not assigned to the subject associated with the given session.

Throws:
WavesetException

getUnassignedAdminRoles

public static java.util.List getUnassignedAdminRoles(LighthouseContext s,
                                                     java.util.List current)
                                              throws WavesetException
Build a list of adminrole names suitable for the assigned adminroles of an administrator. add back in the privately assigned adminroles - since they are already assigned, they can't be excluded or the form will have a constraint violation.

Throws:
WavesetException

getUnassignedAdminRoles

public static java.util.List getUnassignedAdminRoles(LighthouseContext s,
                                                     java.util.List current,
                                                     java.util.Map options)
                                              throws WavesetException
Build a list of capability names suitable for the assigned adminroles of an administrator. add back in the privately assigned adminroles - since they are already assigned, they can't be excluded or the form will have a constraint violation. also allows passing options such as whether or not to filter adminroles not assigned to the current subject or not (e.g. "onlyAssignedToCurrentSubject" true or false)

Throws:
WavesetException

getCapabilities

public static java.util.List getCapabilities(LighthouseContext s)
                                      throws WavesetException
Deprecated. use getCapabilities(LighthouseContext s, Map options) instead

Throws:
WavesetException

getCapabilities

public static java.util.List getCapabilities(LighthouseContext s,
                                             java.util.List current)
                                      throws WavesetException
Deprecated. use getCapabilities(LighthouseContext s, Map options) instead

Throws:
WavesetException

getCapabilities

public static java.util.List getCapabilities(LighthouseContext s,
                                             java.util.List current,
                                             java.util.Map options)
                                      throws WavesetException
Deprecated. use getCapabilities(LighthouseContext s, Map options) instead

Throws:
WavesetException

getCapabilities

public static java.util.List getCapabilities(LighthouseContext s,
                                             java.lang.String matchType,
                                             java.lang.String value)
                                      throws WavesetException
Deprecated. use getCapabilities(LighthouseContext s, Map options) instead

Build a list of the names of resources that match a particular type (like LDAP).

Throws:
WavesetException

getCapabilities

public static java.util.List getCapabilities(LighthouseContext s,
                                             java.util.Map options)
                                      throws WavesetException
Returns a list of capabilities in the authorization scope of the specified lighthouse context. In addition, a map of options can be specified to further filter the list returned. Supported options include: - "scopingOrg" - this options value should be the name of an organization indicating that the returned list should contain only names of the requested type that are "available to" organizations controlled by an AdminRole that controls the organization matching the value of this query option and is assigned to the current logged in user. a common case for this is when a user is assigned more than one AdminRole and you want to ensure that when creating or editing a user, the member organization of the user being created or edited determines what object names of the requested type are available for assignment. - "current" - a list of one or more currently selected capabilities - "conditions" - which can be specified in the following ways: * where the first entry is the name of a queryable attribute supported by this type of object and the second is the value an object of this type must have for the associated queryable attribute in order to be returned (the operator is assumed to be "equals"). If more than one attrname/value pairs are specified, they will be logically and'ed together. * as a list of AttributeCondition objects. For example MemberObjectGroups equals waveset.organization If more than one AttributeCondition is specified, they will be logically and'ed together. - "onlyAssignedToCurrentSubject" which, if true, removes any capabilities from the returned list that are not assigned to the subject associated with the given session.

Throws:
WavesetException

getUnassignedCapabilities

public static java.util.List getUnassignedCapabilities(LighthouseContext s,
                                                       java.util.List current)
                                                throws WavesetException
Build a list of capability names suitable for the assigned capabilities of an administrator. add back in the privately assigned capabilities - since they are already assigned, they can't be excluded or the form will have a constraint violation.

Throws:
WavesetException

getUnassignedCapabilities

public static java.util.List getUnassignedCapabilities(LighthouseContext s,
                                                       java.util.List current,
                                                       java.lang.String currentName)
                                                throws WavesetException
Build a list of capability names suitable for the assigned capabilities of an administrator. add back in the privately assigned capabilities - since they are already assigned, they can't be excluded or the form will have a constraint violation. Finally, this method will remove the name specified as "currentName" if non-null from the list (this is needed when editing a capability, you don't want the capability you're editing to be included in the list of avaialble capabilities to assign).

Throws:
WavesetException

getUnassignedCapabilities

public static java.util.List getUnassignedCapabilities(LighthouseContext s,
                                                       java.util.List current,
                                                       java.util.Map options)
                                                throws WavesetException
Build a list of capability names suitable for the assigned capabilities of an administrator. add back in the privately assigned capabilities - since they are already assigned, they can't be excluded or the form will have a constraint violation. also allows passing options such as whether or not to filter Capabilities not assigned to the current subject or not (e.g. "onlyAssignedToCurrentSubject" true or false)

Throws:
WavesetException

getLoginInterfaceDisplayNames

public static java.util.List getLoginInterfaceDisplayNames(LighthouseContext notUsed)
                                                    throws WavesetException
Return the current list of Lighthouse login interface display names (such as message catalog keys).

Parameters:
notUsed - Context - not actually used, left for backward compatibility - can be null.
Throws:
WavesetException

hasPermission

public static java.lang.Boolean hasPermission(LighthouseContext s,
                                              java.lang.String type,
                                              java.util.List rights)
                                       throws WavesetException
Deprecated. use hasAllPermissions() instead

Returns true if the current authenticated Lighthouse user has all of the specified permission; otherwise, returns false.

Throws:
WavesetException

hasAllPermissions

public static java.lang.Boolean hasAllPermissions(LighthouseContext s,
                                                  java.lang.String type,
                                                  java.util.List rights)
                                           throws WavesetException
Returns true if the current authenticated Lighthouse user has all of the specified permission; otherwise, returns false.

Throws:
WavesetException

hasAnyPermission

public static java.lang.Boolean hasAnyPermission(LighthouseContext s,
                                                 java.lang.String type,
                                                 java.util.List rights)
                                          throws WavesetException
Returns true if the current authenticated Lighthouse user has any of the specified permission; otherwise, returns false.

Throws:
WavesetException

hasAllPermissionsSubType

public static java.lang.Boolean hasAllPermissionsSubType(LighthouseContext s,
                                                         java.lang.String type,
                                                         java.util.List rights)
                                                  throws WavesetException
Returns true if the current authenticated Lighthouse user has all the specified rights to the specified type (or any of its authtype subtypes). It does not imply that the subject has the specified rights to all objects of the specified type or any of its authtype subtypes, since a given object may or may not be in the subject's scope of control or if it is the subject may not have the specified right to the object in that scope.

Therefore, this method is primarily used to determine if the subject has the specified rights to at least one object of the specified type or any of its authtype subtypes.

Throws:
WavesetException

hasAnyPermissionSubType

public static java.lang.Boolean hasAnyPermissionSubType(LighthouseContext s,
                                                        java.lang.String type,
                                                        java.util.List rights)
                                                 throws WavesetException
Returns true if the current authenticated Lighthouse user has any of the specified rights to the specified type (or any of its authtype subtypes). It does not imply that the subject has the specified rights to all objects of the specified type or any of its authtype subtypes, since a given object may or may not be in the subject's scope of control or if it is the subject may not have the specified right to the object in that scope.

Therefore, this method is primarily used to determine if the subject has any of the specified rights to at least one object of the specified type or any of its authtype subtypes.

Throws:
WavesetException

hasPermissionToAnyAuthTypeSubType

public static java.lang.Boolean hasPermissionToAnyAuthTypeSubType(LighthouseContext s,
                                                                  java.lang.String type,
                                                                  java.util.List rights)
                                                           throws WavesetException
Returns true if the current authenticated Lighthouse user has the specified rights to the specified type or any of its authtype subtypes. It does not imply that the subject has the specified rights to all objects of the specified type or any of its authtype subtypes, since a given object may or may not be in the subject's scope of control or if it is the subject may not have the specified right to the object in that scope.

Therefore, this method is primarily used to determine if the subject has the specified rights to at least one object of the specified type or any of its authtype subtypes.

Throws:
WavesetException

hasCapability

public static java.lang.Boolean hasCapability(LighthouseContext s,
                                              java.lang.String capability)
                                       throws WavesetException
Returns true if the current authenticated Lighthouse user has the specified capability; otherwise, returns false. The supported list of capabilities include those returned by listing all objects of type AdminGroup (e.g. "Account Administrator")

Throws:
WavesetException

hasCapabilities

public static java.lang.Boolean hasCapabilities(LighthouseContext s,
                                                java.util.List capabilities)
                                         throws WavesetException
Returns true if the current authenticated Lighthouse user has the all of the specified capabilities; otherwise, returns false. The supported list of capabilities include those returned by listing all objects of type AdminGroup (e.g. "Account Administrator")

Throws:
WavesetException

controlsAtLeastOneOrganization

public static java.lang.Boolean controlsAtLeastOneOrganization(LighthouseContext s,
                                                               java.util.List organizations)
                                                        throws WavesetException
This method will return true if the current authenticated Lighthouse user controls any one of the organizations in the list; otherwise, returns false. The supported list of organizations include those returned by listing all objects of type ObjectGroup

Throws:
WavesetException

getTypesWithRights

public static java.util.List getTypesWithRights(LighthouseContext s)
                                         throws WavesetException
Throws:
WavesetException

getTypeDisplayNamesWithRights

public static java.util.Map getTypeDisplayNamesWithRights(LighthouseContext s)
                                                   throws WavesetException
Returns the set of types with rights that are not deprecated and have a valid java class. The types are returned as a map of entries where each entries key is the type name and value is the type's display name. Can be used for displaying the external name of types in forms while ensuring the correct internal type name is passed to the underlying view.

Parameters:
s - - lighthouse context (session)
Returns:
- map of types where the key is the type name and the value is the types display name
Throws:
WavesetException

getTypeObjectsAvailableToOrg

public static java.util.List getTypeObjectsAvailableToOrg(LighthouseContext s,
                                                          java.lang.String typestr,
                                                          java.lang.String orgid)
                                                   throws WavesetException
Returns a list, for use as allowedValues of a multi-select, of all member objects of the specified org Id and typestr

Throws:
WavesetException

getResourceObject

public static GenericObject getResourceObject(LighthouseContext session,
                                              java.lang.String resourceId,
                                              java.lang.String objectType,
                                              java.lang.String objectId,
                                              java.util.Map options)
                                       throws WavesetException
Returns the requested objectId of the requested objectType from the resource

Parameters:
session - - a valid lighthouse session
objectType - - a valid object type defined in the resource's section
objectId - - a valid fully qualified object identifier on this resource (e.g. "dn")
options - - options can be specified which control the behavior the request. They include:
    "searchAttrsToGet" - a list of objectType specific attribute names to get
Throws:
WavesetException

getResourceObject

public static GenericObject getResourceObject(java.lang.String subjectString,
                                              java.lang.String resourceId,
                                              java.lang.String objectType,
                                              java.lang.String objectId,
                                              java.util.Map options)
                                       throws WavesetException
Returns the requested objectId of the requested objectType from the resource

Parameters:
subjectString - - a valid Lighthouse subject name
objectType - - a valid object type defined in the resource's section
objectId - - a valid fully qualified object identifier on this resource (e.g. "dn")
options - - options can be specified which control the behavior the request. They include:
    "searchAttrsToGet" - a list of objectType specific attribute names to get
Throws:
WavesetException

listResourceObjects

public static java.util.List listResourceObjects(LighthouseContext session,
                                                 java.lang.String objectType,
                                                 java.util.List resourceList,
                                                 java.util.Map options,
                                                 java.lang.String cacheList)
                                          throws WavesetException
This method returns a list of resource object names of the specified resource object type from the specified list of resources (resourceList of Ids or names). In addition, one can specify a set of one or more key / string value pairs specific to the resource from which the object list is being requested. For example, - context ==> dn from where to start collecting list of object names to return - shortname ==> if true, only common name will be returned for dn type object names Note that there is no Waveset authorization check in this method since we are not returning any data controlled by Waveset. The method will run as the currently authenticated administrator (e.g. subject) This method will first attempt to get the list of resource objects of the specified type (e.g. group, distlist, etc.) from the server's resourceObjectListCache. If found, this list will be returned. If not found, the method will invoke the listResourceObjects method on each resource, merge, sort, and remove duplicates on the resulting lists, and finally cache this new list in the server's resourceObjectListCache for any subsequent requests for the same resource object type from the same resource(s). If the caller wants to ensure they are getting the resource object list from the resources and not from the server's cache, they should first invoke the clearResourceObjectListCache() method or set the cacheList argument to 'false'.

Throws:
WavesetException

listResourceObjects

public static java.util.List listResourceObjects(LighthouseContext session,
                                                 java.lang.String objectType,
                                                 java.util.List resourceList,
                                                 java.util.Map options,
                                                 java.lang.String cacheList,
                                                 java.lang.String clearCacheIfExists)
                                          throws WavesetException
Throws:
WavesetException

listResourceObjects

public static java.util.List listResourceObjects(java.lang.String subjectString,
                                                 java.lang.String objectType,
                                                 java.util.List resourceList,
                                                 java.util.Map options,
                                                 java.lang.String cacheList)
                                          throws WavesetException
Variant that takes a Subject string and creates a new Session.

Throws:
WavesetException

listResourceObjects

public static java.util.List listResourceObjects(java.lang.String subjectString,
                                                 java.lang.String objectType,
                                                 java.util.List resourceList,
                                                 java.util.Map options,
                                                 java.lang.String cacheList,
                                                 java.lang.String clearCacheIfExists)
                                          throws WavesetException
Variant that takes a Subject string and creates a new Session.

Throws:
WavesetException

listResourceObjects

public static java.util.List listResourceObjects(LighthouseContext session,
                                                 java.lang.String objectType,
                                                 java.lang.String resourceId,
                                                 java.util.Map options,
                                                 java.lang.String cacheList,
                                                 java.lang.String cacheTimeout,
                                                 java.lang.String clearCacheIfExists)
                                          throws WavesetException
Variant that takes a single resourceid and an existing session; Supports cacheTimeout (e.g. 60000 = 1 minute)

Throws:
WavesetException

listResourceObjects

public static java.util.List listResourceObjects(LighthouseContext session,
                                                 java.lang.String objectType,
                                                 java.lang.String resourceId,
                                                 java.util.Map options,
                                                 java.lang.String cacheList)
                                          throws WavesetException
Variant that takes a single resourceid and an existing session.

Throws:
WavesetException

listResourceObjects

public static java.util.List listResourceObjects(LighthouseContext session,
                                                 java.lang.String objectType,
                                                 java.lang.String resourceId,
                                                 java.util.Map options,
                                                 java.lang.String cacheList,
                                                 java.lang.String clearCacheIfExists)
                                          throws WavesetException
Variant that takes a single resourceid and an existing session.

Throws:
WavesetException

listResourceObjects

public static java.util.List listResourceObjects(java.lang.String subjectString,
                                                 java.lang.String objectType,
                                                 java.lang.String resourceId,
                                                 java.util.Map options,
                                                 java.lang.String cacheList,
                                                 java.lang.String cacheTimeout,
                                                 java.lang.String clearCacheIfExists)
                                          throws WavesetException
Variant that takes a single resourceId and a subject string; Supports cacheTimeout (e.g. 60000 = 1 minute)

Throws:
WavesetException

listResourceObjects

public static java.util.List listResourceObjects(java.lang.String subjectString,
                                                 java.lang.String objectType,
                                                 java.lang.String resourceId,
                                                 java.util.Map options,
                                                 java.lang.String cacheList)
                                          throws WavesetException
Variant that takes a single resourceId and a subject string.

Throws:
WavesetException

listResourceObjects

public static java.util.List listResourceObjects(java.lang.String subjectString,
                                                 java.lang.String objectType,
                                                 java.lang.String resourceId,
                                                 java.util.Map options,
                                                 java.lang.String cacheList,
                                                 java.lang.String clearCacheIfExists)
                                          throws WavesetException
Variant that takes a single resourceId and a subject string.

Throws:
WavesetException

clearResourceObjectListCache

public static void clearResourceObjectListCache(LighthouseContext session,
                                                java.lang.String objectType,
                                                java.util.List resourceList)
                                         throws WavesetException
Variant that takes a list of resourceids and an existing session

Throws:
WavesetException

clearResourceObjectListCache

public static void clearResourceObjectListCache(LighthouseContext session,
                                                java.lang.String objectType,
                                                java.lang.String resourceId)
                                         throws WavesetException
Variant that takes a single resourceid and an existing session.

Throws:
WavesetException

clearResourceObjectListCache

public static void clearResourceObjectListCache(LighthouseContext session,
                                                java.lang.String objectType,
                                                java.lang.String resourceId,
                                                java.util.Map templateParameters)
                                         throws WavesetException
Variant that takes a single resourceid (supporting resource templates) and an existing session.

Throws:
WavesetException

clearResourceObjectListCache

public static void clearResourceObjectListCache(java.lang.String subjectString,
                                                java.lang.String objectType,
                                                java.util.List resourceList)
                                         throws WavesetException
Variant that takes a list of resourceids and a subject string

Throws:
WavesetException

clearResourceObjectListCache

public static void clearResourceObjectListCache(java.lang.String subjectString,
                                                java.lang.String objectType,
                                                java.lang.String resourceId)
                                         throws WavesetException
Variant that takes a single resourceId and a subject string.

Throws:
WavesetException

clearResourceObjectListCache

public static void clearResourceObjectListCache(java.lang.String subjectString,
                                                java.lang.String objectType,
                                                java.lang.String resourceId,
                                                java.util.Map templateParameters)
                                         throws WavesetException
Variant that takes a single resourceid (supporting resource templates) and a subject string.

Throws:
WavesetException

getResourceObjects

public static java.util.List getResourceObjects(LighthouseContext session,
                                                java.lang.String objectType,
                                                java.lang.String resourceId,
                                                java.util.Map options)
                                         throws WavesetException
Parameters:
session - - a valid lighthouse session
objectType - - the name of a valid object class for this specified "resId". If null, will return objects of all object types defined by the specified resId found within the specified search container and scope.
resourceId - - the resource from which to get the objects
options - - several options can be specified which control the behavior of the search. They include:
    "searchContext" - the value of this option determines within what context to perform search (ResourceAdapter.RA_SEARCH_CONTEXT). If not specified, will attempt to get a value from RA_BASE_CONTEXT. If no value, will assume search should be done from logical top.
  1. "searchFilter" - optional specification, in LDAP search filter format as specified in RFC 1558, of one or more object tuples either and'ed or or'ed together. If not specified, a filter will be constructed using the specified objectType. (ResourceAdapter.SEARCH_FILTER).
  2. "searchScope" - specifies whether the search should be done on the current object, only within the context of the specified "searchContext", or in all subcontext within the specified "searchContext" (ResourceAdapter.RA_SEARCH_SCOPE). Valid values are "object", "oneLevel", or "subTree" indicates that the search should be performed on all sub contexts within the specified "searchContext".
  3. "searchTimeLimit" - the timelimit in milliseconds a search should not exceed (ResourceAdapter.RA_SEARCH_TIME_LIMIT).
  4. "searchAttrsToGet" - the list of objectType specific attribute names to get per object
  5. "runAsUser" - user name this request is to be run as. If not specified, defaults to resource proxy admin user.
  6. "runAsPassword" - password of runAsUser. Required to authenticate with resource in order to run the list request as the specified user
Returns:
a list of objects where each object contains a set of attributes, including type, name, and id (fully-qualified name such as DN), as well as any requested searchAttrsToGet

Throws:
WavesetException

getResourceObjects

public static java.util.List getResourceObjects(LighthouseContext session,
                                                java.lang.String objectType,
                                                java.lang.String resourceId,
                                                java.util.Map options,
                                                java.lang.String cacheList,
                                                java.lang.String cacheTimeout,
                                                java.lang.String clearCacheIfExists)
                                         throws WavesetException
Same function as getResourceObjects above, plus the ability to cache and manage the cache of the returned objects
    cachList - "true" to have the returned list of objects cached by the server; otherwise "false"
  1. cacheTimeout - if cacheList is true, this can set the number of milliseconds before the cache times out. When the cache times out, the object will automatically be retrieved from the resource the next time they are requested (e.g. 60000 = 1 minute)
  2. clearCacheIfExists - force the cache to be cleared and the objects to be re fetched from the resource the next time they are requested

Throws:
WavesetException

getResourceObjects

public static java.util.List getResourceObjects(java.lang.String subjectString,
                                                java.lang.String objectType,
                                                java.lang.String resourceId,
                                                java.util.Map options)
                                         throws WavesetException
Parameters:
subjectString - - a valid lighthouse serialized subject
objectType - - the name of a valid object class for this specified "resId". If null, will return objects of all object types defined by the specified resId found within the specified search container and scope.
resourceId - - the resource from which to get the objects
options - - several options can be specified which control the behavior of the search. They include:
    "searchContext" - the value of this option determines within what context to perform search (ResourceAdapter.RA_SEARCH_CONTEXT). If not specified, will attempt to get a value from RA_BASE_CONTEXT. If no value, will assume search should be done from logical top.
  1. "searchFilter" - optional specification, in LDAP search filter format as specified in RFC 1558, of one or more object tuples either and'ed or or'ed together. If not specified, a filter will be constructed using the specified objectType. (ResourceAdapter.SEARCH_FILTER).
  2. "searchScope" - specifies whether the search should be done on the current object, only within the context of the specified "searchContext", or in all subcontext within the specified "searchContext" (ResourceAdapter.RA_SEARCH_SCOPE). Valid values are "object", "oneLevel", or "subTree" indicates that the search should be performed on all sub contexts within the specified "searchContext".
  3. "searchTimeLimit" - the timelimit in milliseconds a search should not exceed (ResourceAdapter.RA_SEARCH_TIME_LIMIT).
  4. "searchAttrsToGet" - the list of objectType specific attribute names to get per object
  5. "runAsUser" - user name this request is to be run as. If not specified, defaults to resource proxy admin user.
  6. "runAsPassword" - password of runAsUser. Required to authenticate with resource in order to run the list request as the specified user
Returns:
a list of objects where each object contains a set of attributes, including type, name, and id (fully-qualified name such as DN), as well as any requested attrsToGet.

Throws:
WavesetException

getResourceObjects

public static java.util.List getResourceObjects(java.lang.String subjectString,
                                                java.lang.String objectType,
                                                java.lang.String resourceId,
                                                java.util.Map options,
                                                java.lang.String cacheList,
                                                java.lang.String cacheTimeout,
                                                java.lang.String clearCacheIfExists)
                                         throws WavesetException
Same function as getResourceObjects above, plus the ability to cache and manage the cache of the returned objects
    cachList - "true" to have the returned list of objects cached by the server; otherwise "false"
  1. cacheTimeout - if cacheList is true, this can set the number of milliseconds before the cache times out. When the cache times out, the object will automatically be retrieved from the resource the next time they are requested (e.g. 60000 = 1 minute)
  2. clearCacheIfExists - force the cache to be cleared and the objects to be re fetched from the resource the next time they are requested

Throws:
WavesetException

getResourceIdentity

public static java.lang.String getResourceIdentity(java.lang.String subjectString,
                                                   java.lang.String resourceId)
                                            throws WavesetException
Throws:
WavesetException

getResourceIdentity

public static java.lang.String getResourceIdentity(Session session,
                                                   java.lang.String resourceId)
                                            throws WavesetException
Throws:
WavesetException

getResourceSchemaAttributeNames

public static java.util.List getResourceSchemaAttributeNames(LighthouseContext context,
                                                             java.lang.String nameOrId)
                                                      throws WavesetException
Throws:
WavesetException

getResourceSchemaResourceAttributeNames

public static java.util.List getResourceSchemaResourceAttributeNames(LighthouseContext context,
                                                                     java.lang.String nameOrId)
                                                              throws WavesetException
Throws:
WavesetException

getResourceObjectTypeAttributeNames

public static java.util.List getResourceObjectTypeAttributeNames(LighthouseContext context,
                                                                 java.lang.String resourceName,
                                                                 java.lang.String objectType)

getResourceAttributeFromResource

public static java.lang.Object getResourceAttributeFromResource(LighthouseContext context,
                                                                java.lang.String resourceName,
                                                                java.lang.String resourceAttribute)
                                                         throws WavesetException
For the resource specified by resourceName, return the value for the resource attribute specified by resourceAttribute.

Throws:
WavesetException

getResourceAccountAttributeMapping

public static java.lang.Object getResourceAccountAttributeMapping(LighthouseContext context,
                                                                  java.lang.String resourceName,
                                                                  java.lang.String leftHandSideName)
                                                           throws WavesetException
For the resource specified by resourceName, return the value for the resource account attribute in the schema map that corresponds to the IDM attribute with name leftHandSideName.

Throws:
WavesetException

getResourceAccountAttributeType

public static java.lang.Object getResourceAccountAttributeType(LighthouseContext context,
                                                               java.lang.String resourceName,
                                                               java.lang.String leftHandSideName)
                                                        throws WavesetException
For the resource specified by resourceName, return the type of the resource account attribute in the schema map that corresponds to the IDM attribute with name leftHandSideName.

Throws:
WavesetException

callResourceMethod

public static java.lang.Object callResourceMethod(LighthouseContext context,
                                                  java.lang.String resourceName,
                                                  java.lang.String methodName,
                                                  java.util.Map args)
                                           throws WavesetException
This method will invoke the specified method on the specified resource, passing the given Map of arguments into the method, if the current subject has view access to the specified resource. NOTE: This is restricted to only call resource methods which have take a single argument that is a Map. If the resource method takes more than one argument or the argument required by the resource method is not a Map this method cannot be used to call it.

Throws:
WavesetException

getListOfDnComponents

public static java.util.List getListOfDnComponents(java.util.List dnlist,
                                                   java.lang.String componentName)
Given a list of dn's and the component type to return (e.g. "cn="), returns a list of component names.


getListOfDnComponents

public static java.util.List getListOfDnComponents(java.lang.String dn,
                                                   java.lang.String componentName)
Given a dn's and the component type to return (e.g. "cn="), returns the component name in a list (useful for form invoke when not sure if value returned from adapter is a single string or a list of strings)


getDnComponent

public static java.lang.String getDnComponent(java.lang.String dn,
                                              java.lang.String componentName)
Given a dn's and the component type to return (e.g. "cn="), returns the component name as a string


buildDns

public static java.util.List buildDns(java.lang.String names,
                                      java.lang.String delimeter,
                                      java.lang.String baseContext)
Takes a string, the delimeter with which to parse the string, and the baseContext to append to each token in the string. Returns a list of fully qualified dn names. (can be called for processing the contexts of a TextArea gadget)


buildDns

public static java.util.List buildDns(java.util.List names,
                                      java.lang.String baseContext)
Takes a list of names and the baseContext to append to each token in the list. Returns a list of fully qualified dn names. (can be called for processing the contexts of a TextArea gadget)


buildDn

public static java.lang.String buildDn(java.lang.String name,
                                       java.lang.String baseContext)
Takes a names and the baseContext to append to the name. Returns a fully qualified dn name.


isFeatureSupported

public static boolean isFeatureSupported(LighthouseContext ctx,
                                         java.lang.String resourceName,
                                         java.lang.String featureName)
                                  throws WavesetException
Determine whether the given resource supports and has the given feature enabled.

Parameters:
ctx - The LighthouseContext to use.
resourceName - The name of the resource.
featureName - The constant of the feature. See ResourceAdapter.Features for a list of features.
Returns:
True if give resource supports the and has the given feature enabled, false otherwise.
Throws:
WavesetException - If the resource cannot be loaded.
See Also:
ResourceAdapter.Features

getAuditActions

public static java.util.List getAuditActions(LighthouseContext s,
                                             java.lang.String objectType)
                                      throws WavesetException
Get a list of audit actions available to the given content for the objectType. Used by the reporting forms.

Throws:
WavesetException

getAuditActions

public static java.util.List getAuditActions(LighthouseContext s,
                                             java.lang.String objectType,
                                             boolean includeAll)
                                      throws WavesetException
Throws:
WavesetException

getAuditObjectTypes

public static java.util.List getAuditObjectTypes(LighthouseContext s)
                                          throws WavesetException
Get a list of audit object types available to the given context. Used by the reporting forms.

Throws:
WavesetException

getAuditStatusList

public static java.util.List getAuditStatusList(LighthouseContext s)
                                         throws WavesetException
Get a list of audit status types available to the given context. Used by the reporting forms.

Throws:
WavesetException

getAuditStatusList

public static java.util.List getAuditStatusList(LighthouseContext s,
                                                boolean includeAll)
                                         throws WavesetException
Throws:
WavesetException

getTypeDisplayName

public static java.lang.String getTypeDisplayName(LighthouseContext s,
                                                  java.lang.String typeName)
                                           throws WavesetException
Get the display name of a Type, given it name. This method will also check the extended audit types.

Throws:
WavesetException

getTypeNamesWithEncryptedData

public static java.util.List getTypeNamesWithEncryptedData()
                                                    throws WavesetException
List object types that support having encrypted data within

Throws:
WavesetException

getStartupTypesMap

public static java.util.Map getStartupTypesMap()
Get a map that contains the ActiveSync startup types. The key of the map is the name of the startup type and the value of the map is the displayName. This can be used directly as the value of the valueMap property for a Select component.


testObject

public static java.lang.String testObject(LighthouseContext s,
                                          java.lang.String typeName,
                                          java.lang.String id)
Created for the Dell demo, where end users need to be able to launch processes to create new users, and need to test to see if a user with a certain name already exists. Returns the string "true" if the object exists, or null.


testUser

public static java.lang.String testUser(LighthouseContext s,
                                        java.lang.String id)

formatDate

public static java.lang.String formatDate(java.lang.String src)
Given a string containing the long integer representation of a Date, return a formatted date string. Ocassionally necessary in forms to render timestamps. But since there is no WSAttribute representation for a long, it has to be stored as a string.


getSessionForActiveSyncResource

public static Session getSessionForActiveSyncResource(java.lang.String name)
                                               throws WavesetException
Throws:
WavesetException

listServers

public static java.util.List listServers(LighthouseContext s)
                                  throws WavesetException
Returns:
the names of known servers.
Throws:
WavesetException

convertDateToString

public static java.lang.String convertDateToString(java.lang.String dateStr,
                                                   java.lang.String simpleDateFormatPattern)
Convert the string representation for a date into a different date string format. The string may be of the following forms: M/d/y H:m:s z M/d/y H:m:s M/d/y yyyyMMdd HH:mm:ss (default) yyyyMMdd HH:mm:ss.SSS (canonical) nnnnnnnnnnnnnnnnn (milliseconds)


convertDateToString

public static java.lang.String convertDateToString(java.util.Date date,
                                                   java.lang.String simpleDateFormatPattern)
Convert a date into a different date into the requested string format. The string may be of the following forms: M/d/y H:m:s z M/d/y H:m:s M/d/y yyyyMMdd HH:mm:ss (default) yyyyMMdd HH:mm:ss.SSS (canonical) nnnnnnnnnnnnnnnnn (milliseconds)


getRelativeDateString

public static java.lang.String getRelativeDateString(int ord,
                                                     int day,
                                                     int mo,
                                                     java.lang.String simpleDateFormatPattern)
Generates a date string expressed in a future time such as "the second Monday in October". If the current time is BEFORE the date generated by the input parameters, the date will be for the current year. If the current time is AFTER the date generated, the year will be incremented by one such that the date occurs in the future.

Parameters:
ord - Integer representing the ordinal of the day of the week for the generated date and must be a number between 1 and 5 inclusive. If there are only four days in the month and the value of this parameter is 5, the result of this method call is undefined.
day - Integer representing a day of the week. Legal values correspond with constants used by the Calendar class, namely:
          1 (Sunday)
          2 (Monday)
          3 Tuesday)
          4 (Wednesday)
          5 (Thursday)
          6 (Friday)
          7 (Saturday)
        
mo - Integer representing a month. Legal values correspond with constants used by the Calendar class, namely:
          0 (January)
          1 (February)
          2 (March)
          3 (April)
          4 (May)
          5 (June)
          6 (July)
          7 (August)
          8 (September)
          9 (October)
          10 (November)
          11 (December)
        
simpleDateFormatPattern - formatter for the returned data strings of one of the forms:
		    M/d/y H:m:s z
 		    M/d/y H:m:s
 		    M/d/y
		    yyyyMMdd HH:mm:ss	(default)
		    yyyyMMdd HH:mm:ss.SSS	(canonical)
		    nnnnnnnnnnnnnnnnn	(milliseconds)
        
Returns:
a time/date string formatted according to simpleDateFormatPatern

getRelativeDateString

public static java.lang.String getRelativeDateString(int field,
                                                     int amount,
                                                     java.lang.String simpleDateFormatPattern)
Generates a data string expressed as a number of units from now such as "5 minutes from now"

Parameters:
field - Integer corresponding to the field of the date to increment. Legal values correspond with constants used by the Calendar class, namely: 0 (era) 1 (year) 2 (month) 3 (week of year) 4 (week of month) 5 (day of month) 6 (day of year) 7 (day of week) 8 (day of week in month) 9 (am/pm) 10 (hour) 11 (hour of day) 12 (minute) 13 (second) 14 (millisecond) 15 (zone offset) 16 (daylight savings time offset)
amount -
simpleDateFormatPattern - formatter for the returned data strings of one of the forms:
		    M/d/y H:m:s z
 		    M/d/y H:m:s
 		    M/d/y
		    yyyyMMdd HH:mm:ss	(default)
		    yyyyMMdd HH:mm:ss.SSS	(canonical)
		    nnnnnnnnnnnnnnnnn	(milliseconds)
        
Returns:
a time/date string formatted according to simpleDateFormatPatern

getRepetitionUnitsMap

public static java.util.Map getRepetitionUnitsMap()
Get a map that contains the TaskSchedule repetition units. The key of the map is the name of the repitition unit and the value of the map is the displayName. This can be used directly as the value of the valueMap property for a Select component.


getFormFieldNames

public static java.util.List getFormFieldNames(LighthouseContext s,
                                               java.lang.String processName)
                                        throws WavesetException
Returns a list of attributes from a form. The list of attributes is filtered to NOT include container UI widgets.

Parameters:
s -
processName - String used to access the form from which attributes will be retrieved. If null, defaults to 'userForm'.
Returns:
list of all attributes from the form
Throws:
WavesetException

getAttributesSelectOptionGroupMap

public static java.util.Map getAttributesSelectOptionGroupMap(LighthouseContext s)
                                                       throws WavesetException
Builds data structure appropriate for the 'optionsGroupMap' property of a Select component that displays all form and resource attributes. See Select.setOptionGroupMap(java.util.Map) for details on the structure of this map.

Parameters:
s -
Returns:
map appriate for the optionGroupMap property of a Select component
Throws:
WavesetException
See Also:
Select

getAttributesSelectOptionGroupMap

public static java.util.Map getAttributesSelectOptionGroupMap(LighthouseContext s,
                                                              java.util.Map additionalEntries,
                                                              java.lang.String additionalEntriesMsg)
                                                       throws WavesetException
Builds data structure appropriate for the 'optionsGroupMap' property of a Select component that displays resource attributes. Attributes that are found on multiple resources are grouped in an option group called "Common Attributes". Fully-qualified names are not used. The Map of additionalEntries (mapping attribute name to display name) is stored in the map under the additionalEntriesMsg option group. See Select.setOptionGroupMap(java.util.Map) for details on the structure of this map.

Parameters:
s -
additionalEntries - The additional attributes to store in the map.
additionalEntriesMsg - The message key of the option group under which to store the additional entries.
Returns:
map appriate for the optionGroupMap property of a Select component
Throws:
WavesetException
See Also:
Select

getAttributesSelectValueMap

public static java.util.Map getAttributesSelectValueMap(LighthouseContext s)
                                                 throws WavesetException
Builds data structure appropriate for the 'valueMap' property of a Select component that displays all form and resource attributes. See Select.setValueMap(java.util.Map) for details on the structure of this map.

Parameters:
s -
Returns:
map appropriate for the valueMap property of a Select component
Throws:
WavesetException
See Also:
Select

getResourceAttributes

public static java.util.List getResourceAttributes(LighthouseContext s,
                                                   java.lang.String resource)
                                            throws WavesetException
Return a list of the attributes in the schema map for a particular resource.

Throws:
WavesetException

getCodeId

public static java.lang.String getCodeId(java.lang.String c)
Get the code id from the class specified by the string.

Parameters:
c - - Fully qualified classname.
Returns:
the codeId for the specified class if it exists; otherwise returns null.

getCodeId

public static java.lang.String getCodeId(java.lang.Class c)
Get the code id from the class.

Parameters:
c - Specified class.
Returns:
the codeId for the specified class if it exists; otherwise returns null.

getVersionFromCodeId

public static java.lang.String getVersionFromCodeId(java.lang.String codeid)
Get the version number from the CVS code id.

Parameters:
codeid - Code id to parse.
Returns:
the version in string form otherwise null.

getCodeIdVersion

public static java.lang.String getCodeIdVersion(java.lang.String clazz)
Get the version of the code id from the class.

Parameters:
clazz - Full qualified class to query.
Returns:
Returns the version otherwise null.

getCodeIdVersion

public static java.lang.String getCodeIdVersion(java.lang.Class clazz)
Get the version of the code id from the class.

Parameters:
clazz - Class to query.
Returns:
Returns the version otherwise null.

getAccountAttributeType

public static java.lang.String getAccountAttributeType(LighthouseContext session,
                                                       java.lang.String fqAttrName)
Returns the 'type' of an attribute

Parameters:
session -
fqAttrName - fully qualified attribute name expressed something like user.waveset.roles or user.accounts[ldap dir].name
Returns:
name of the attribute type (ie string, date etc)

isAccountAttributeMultiValued

public static boolean isAccountAttributeMultiValued(LighthouseContext session,
                                                    java.lang.String fqAttrName)
Determines multivalue property of an attribute

Parameters:
session -
fqAttrName - fully qualified attribute name expressed something like user.waveset.roles or user.accounts[ldap dir].name
Returns:
string 'true' if the attribute is multivalued

getDisplayLocale

public static java.util.Locale getDisplayLocale(Session session)
Extract the locale from the session. The Locale won't always be available in the session, so only rely on this if you can invoke this with :display.session.


getTimeZoneIdToDisplayNameMap

public static java.util.List getTimeZoneIdToDisplayNameMap(java.util.Locale locale)
This was too complex to manage with express.


getLocalizedHelpAsString

public static final java.lang.String getLocalizedHelpAsString(Session displaySession,
                                                              java.lang.Object help)
This allows us to use Messsages for help objects. It's not as nice as having a setHelp(Message) on Component, but it's not as invasive since it's rare to have i-help that requires parameters.


formatTransactionText

public static final java.lang.String formatTransactionText(java.util.Locale locale,
                                                           java.util.List attrNames,
                                                           java.util.List attrValues)
Used for formatting the transaction text to be signed for signed approvals.

Parameters:
locale - The locale to display in
attrNames - The list of attribute names to display
attrValues - The list of attribute values to display

getInstalledLocales

public static final java.util.List getInstalledLocales(java.util.List localeIds,
                                                       java.util.Locale displayLocale)
This can be used as the valueMap property of a Select component to allow the user to select their locale. Returns a list of alternating localeId (as determined by Locales.localeToString) and the display name for the locale according to displayLocale. The code restricts the locales to the ones defined by localeIds and any CustomCatalog that is installed. displayLocale can be null to use the default locale.


getObjectAttributeNames

public static java.util.List getObjectAttributeNames(GenericObject obj)
Returns the (String) List of attribute names for the supplied GenericObject

Parameters:
obj - the GenericObject
Returns:
the list of attribute names found in obj

getAvailablePDFFonts

public static java.util.List getAvailablePDFFonts()
Returns:
a list of installed PDF fonts. These are the default PDF fonts (e.g. Helvetica) as well as any fonts the user has specified in the WEB-INF/fonts directory.

getAvailableCharsets

public static java.util.Map getAvailableCharsets()
Returns:
a list of available Charsets

getAuditPublisherMap

public static java.util.Map getAuditPublisherMap(LighthouseContext context)
                                          throws WavesetException
Returns:
a map of registered audit publishers, where the key is the class name and the value is the display name of the publisher.
Throws:
WavesetException

getAuditFormatterMap

public static java.util.Map getAuditFormatterMap(LighthouseContext context)
                                          throws WavesetException
Throws:
WavesetException

getAuditPublisherOptions

public static java.util.List getAuditPublisherOptions(java.lang.String className)

getServletContextPath

public static java.lang.String getServletContextPath(RequestState request)