001package org.apache.archiva.redback.common.ldap.user;
002
003/*
004 * Licensed to the Apache Software Foundation (ASF) under one
005 * or more contributor license agreements.  See the NOTICE file
006 * distributed with this work for additional information
007 * regarding copyright ownership.  The ASF licenses this file
008 * to you under the Apache License, Version 2.0 (the
009 * "License"); you may not use this file except in compliance
010 * with the License.  You may obtain a copy of the License at
011 *
012 * http://www.apache.org/licenses/LICENSE-2.0
013 *
014 * Unless required by applicable law or agreed to in writing,
015 * software distributed under the License is distributed on an
016 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
017 * KIND, either express or implied.  See the License for the
018 * specific language governing permissions and limitations
019 * under the License.
020 */
021
022import org.apache.archiva.redback.common.ldap.MappingException;
023import org.apache.archiva.redback.users.User;
024
025import javax.naming.directory.Attributes;
026
027/**
028 *
029 */
030public interface UserMapper
031{
032    LdapUser getUser( String dn, Attributes attributes )
033        throws MappingException;
034
035    Attributes getCreationAttributes( User user, boolean encodePasswordIfChanged )
036        throws MappingException;
037
038    UserUpdate getUpdate( LdapUser user )
039        throws MappingException;
040
041    String[] getUserAttributeNames();
042
043    String getEmailAddressAttribute();
044
045    String getUserFullNameAttribute();
046
047    String getPasswordAttribute();
048
049    String getUserIdAttribute();
050
051    String getEmailAttribute();
052
053    String getUserBaseDn();
054
055    String getUserObjectClass();
056
057    String getUserFilter();
058
059    LdapUser newUserInstance( String username, String fullName, String email );
060
061    LdapUser newTemplateUserInstance();
062
063    String[] getReturningAttributes();
064
065    void initialize();
066
067}