All Downloads are FREE. Search and download functionalities are using the official Maven repository.

edu.internet2.middleware.grouper.ui.util.DefaultMembershipImporter Maven / Gradle / Ivy

There is a newer version: 5.13.5
Show newest version
/*******************************************************************************
 * Copyright 2012 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.
 ******************************************************************************/
/*
Copyright 2004-2007 University Corporation for Advanced Internet Development, Inc.
Copyright 2004-2007 The University Of Bristol

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.
*/

package edu.internet2.middleware.grouper.ui.util;

import java.io.IOException;
import java.io.LineNumberReader;
import java.io.Reader;
import java.io.PrintWriter;
import java.util.ResourceBundle;

import org.w3c.dom.Element;

import edu.internet2.middleware.grouper.Field;
import edu.internet2.middleware.grouper.Group;
import edu.internet2.middleware.grouper.SubjectFinder;
import edu.internet2.middleware.grouper.exception.SchemaException;
import edu.internet2.middleware.grouper.ui.GrouperUiFilter;
import edu.internet2.middleware.subject.Subject;
import edu.internet2.middleware.subject.SubjectNotFoundException;
import edu.internet2.middleware.subject.SubjectNotUniqueException;

/**
 * Default implementation of the MembershipImporter interface. This class
 * expects single line records e.g. tab/comma separated fields where one
 * of the fields can be used to lookup a Subject by id or identifier.
 * 

This class expects to find the following attributes in the config Element:
* separator e.g. ',' or '\t', used to determine fields
* id-field - an integer used to determine which field position to use to lookup a Subject>br/> * field-type - 'id' or 'identifier' specifies the type of lookup to do
* ignore-existing - 'false' or 'true' determies whether trying to add an existing member is considered an error

*

Other implementations * can be as complex as necessary *

* * @author Gary Brown. * @version $Id: DefaultMembershipImporter.java,v 1.6 2009-08-12 04:52:14 mchyzer Exp $ */ public class DefaultMembershipImporter implements MembershipImporter{ /* (non-Javadoc) * @see edu.internet2.middleware.grouper.ui.util.MembershipImporter#load(edu.internet2.middleware.grouper.Group, java.io.Reader, java.io.PrintWriter, org.w3c.dom.Element, edu.internet2.middleware.grouper.Field, java.util.ResourceBundle)

Recognises the following config Element attributes:

separator used to split input lines into fields
id-field integer, starting at 1, which indicates which field should be used to 'lookup' a subject
field-type =id or identifier. Specifies how to lookup a subject
* **/ public int load(Group group, Reader input, PrintWriter output,Element config,Field field) throws IOException,SchemaException { ResourceBundle nav = GrouperUiFilter.retrieveSessionNavResourceBundle(); int errorCount=0; String separator=config.getAttribute("separator"); if(separator==null || separator.equals("")) throw new IllegalArgumentException(nav.getString("groups.import.message.no-separator")); if(separator.equals("\\t")) separator="\t"; int idField = Integer.parseInt(config.getAttribute("id-field"))-1; String fieldType=config.getAttribute("field-type"); boolean useId=false; if("id".equals(fieldType)) { useId=true; }else if(!"identifier".equals(fieldType)) { throw new IllegalArgumentException(nav.getString("groups.import.message.bad-field-type")); } boolean ignoreExisting = Boolean.parseBoolean(config.getAttribute("ignore-existing")); String line; String[] parts; String id; Subject subject; LineNumberReader lineInput = new LineNumberReader(input); int lineCount=0; while ((line=lineInput.readLine())!=null) { lineCount++; parts=line.split(separator); if(parts.length" + error + "\n"); } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy