# Copyright 2016 Internet2
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
 
#
# Subject configuration
#
 
# The subject properties uses Grouper Configuration Overlays (documented on wiki)
# By default the configuration is read from subject.base.properties
# (which should not be edited), and the subject.properties overlays
# the base settings.  See the subject.base.properties for the possible
# settings that can be applied to the subject.properties
 
# enter the location of the sources.xml.  Must start with classpath: or file:
# blank means dont use sources.xml, use subject.properties
# default is: classpath:sources.xml
# e.g. file:/dir1/dir2/sources.xml
subject.sources.xml.location =
 
 
#########################################
## Configuration for source id: ucildap
## Source configName: ucildap
#########################################
subjectApi.source.ucildap.id = ucildap

# this is a friendly name for the source
subjectApi.source.ucildap.name = UCI OIT Public LDAP

# type is not used all that much.  Can have multiple types, comma separate.  Can be person, group, application
subjectApi.source.ucildap.types = person

# the adapter class implements the interface: edu.internet2.middleware.subject.Source
# adapter class must extend: edu.internet2.middleware.subject.provider.BaseSourceAdapter
# edu.internet2.middleware.grouper.subj.GrouperJdbcSourceAdapter2  :  if doing JDBC this should be used if possible.  All subject data in one table/view.
# edu.internet2.middleware.grouper.subj.GrouperJdbcSourceAdapter   :  oldest JDBC source.  Put freeform queries in here
# edu.internet2.middleware.grouper.subj.GrouperJndiSourceAdapter   :  used for LDAP
#subjectApi.source.ucildap.adapterClass = edu.internet2.middleware.grouper.subj.GrouperJdbcSourceAdapter
subjectApi.source.ucildap.adapterClass = edu.internet2.middleware.grouper.subj.GrouperJndiSourceAdapter

# e.g. com.sun.jndi.ldap.LdapCtxFactory
subjectApi.source.ucildap.param.INITIAL_CONTEXT_FACTORY.value = com.sun.jndi.ldap.LdapCtxFactory

# e.g. ldap://localhost:389
subjectApi.source.ucildap.param.PROVIDER_URL.value = ldap://ldap.oit.uci.edu:389/dc=uci,dc=edu
 
# e.g. simple, none, sasl_mech
subjectApi.source.ucildap.param.SECURITY_AUTHENTICATION.value = none
 
# ldap attribute which is the subject id.  e.g. exampleEduRegID   Each subject has one and only one subject id.  Generally it is opaque and permanent.
subjectApi.source.ucildap.param.SubjectID_AttributeType.value = uciCampusID
 
# if the subject id should be changed to lower case after reading from datastore.  true or false
subjectApi.source.ucildap.param.SubjectID_formatToLowerCase.value = false
 
# attribute which is the subject name
subjectApi.source.ucildap.param.Name_AttributeType.value = cn
 
# attribute which is the subject description
subjectApi.source.ucildap.param.Description_AttributeType.value = nameLong

# when evaluating the virtual attribute EL expression, this variable can be used from this java class.
# subjectVirtualAttributeVariable_grouperUtilElSafe variable is the edu.internet2.middleware.grouper.util.GrouperUtilElSafe class. Call static methods
subjectApi.source.ucildap.param.subjectVirtualAttributeVariable_grouperUtilElSafe.value = edu.internet2.middleware.grouper.util.GrouperUtilElSafe
 
# This virtual attribute index 0 is accessible via: subject.getAttributeValue("nameLong");
subjectApi.source.ucildap.param.subjectVirtualAttribute_0_nameLong.value = ${grouperUtilElSafe.appendIfNotBlankString(grouperUtilElSafe.defaultIfBlank(subject.getAttributeValue('cn'), ''), ' - ', grouperUtilElSafe.defaultIfBlank(subject.getAttributeValue('eduPersonSchoolCollegeName'), ''))}

 
# the 1st sort attribute for lists on screen that are derived from member table (e.g. search for member in group)
# you can have up to 5 sort attributes
subjectApi.source.ucildap.param.sortAttribute0.value = nameLong
 
# the 1st search attribute for lists on screen that are derived from member table (e.g. search for member in group)
# you can have up to 5 search attributes
subjectApi.source.ucildap.param.searchAttribute0.value = namelong
 
# attribute name of the email attribute
subjectApi.source.ucildap.param.emailAttributeName.value = mail
 
#searchSubject: find a subject by ID.  ID is generally an opaque and permanent identifier, e.g. 12345678.
#  Each subject has one and only on ID.  Returns one result when searching for one ID.
 
# sql is the sql to search for the subject by id.  %TERM% will be subsituted by the id searched for
subjectApi.source.ucildap.search.searchSubject.param.filter.value = (& (uciCampusID=%TERM%) (objectclass=eduPerson))
 
# Scope Values can be: OBJECT_SCOPE, ONELEVEL_SCOPE, SUBTREE_SCOPE
subjectApi.source.ucildap.search.searchSubject.param.scope.value = ONELEVEL_SCOPE
 
# base dn to search in
subjectApi.source.ucildap.search.searchSubject.param.base.value = ou=person
 
#searchSubjectByIdentifier: find a subject by identifier.  Identifier is anything that uniquely
#  identifies the user, e.g. jsmith or jsmith@institution.edu.
#  Subjects can have multiple identifiers.  Note: it is nice to have if identifiers are unique
#  even across sources.  Returns one result when searching for one identifier.
 
# sql is the sql to search for the subject by identifier.  %TERM% will be subsituted by the identifier searched for
subjectApi.source.ucildap.search.searchSubjectByIdentifier.param.filter.value = (& (uciCampusID=%TERM%) (objectclass=eduPerson))
 
# Scope Values can be: OBJECT_SCOPE, ONELEVEL_SCOPE, SUBTREE_SCOPE
subjectApi.source.ucildap.search.searchSubjectByIdentifier.param.scope.value = ONELEVEL_SCOPE
 
# base dn to search in
subjectApi.source.ucildap.search.searchSubjectByIdentifier.param.base.value = ou=person
 
#   search: find subjects by free form search.  Returns multiple results.
 
# sql is the sql to search for the subject by free form search.  %TERM% will be subsituted by the text searched for
subjectApi.source.ucildap.search.search.param.filter.value = (& (|(|(uid=%TERM%)(cn=*%TERM%*))(uciCampusID=%TERM%))(objectclass=eduPerson))

# Scope Values can be: OBJECT_SCOPE, ONELEVEL_SCOPE, SUBTREE_SCOPE
subjectApi.source.ucildap.search.search.param.scope.value = ONELEVEL_SCOPE
 
# base dn to search in
subjectApi.source.ucildap.search.search.param.base.value = ou=person
 
# attributes from ldap object to become subject attributes.  comma separated
subjectApi.source.ucildap.attributes = department, departmentNumber, sn, displayName, uciAffiliation, mail
 
# internal attributes are used by grouper only not exposed to code that uses subjects.  comma separated
subjectApi.source.ucildap.internalAttributes = searchAttribute0

