org.apache.jetspeed.security.spi.JetspeedPrincipalLookupManager Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jetspeed-security Show documentation

Jetspeed-2 Security Components

The newest version!

/* 
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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 org.apache.jetspeed.security.spi;

import org.apache.jetspeed.security.JetspeedPrincipalQueryContext;
import org.apache.jetspeed.security.JetspeedPrincipalResultList;

/**
 * @author Joachim Mueller
 * 
 */
public interface JetspeedPrincipalLookupManager {

	/**
	 * Retrieves all principals that match the queryContext. It
	 * actually takes care of the SQL generation, querying and building the
	 * {@see JetspeedPrincipalResultList}.
	 * 
	 * The implementation of this method can be database specific.
	 * 
	 * @param queryContext
	 * @return
	 */
	JetspeedPrincipalResultList getPrincipals(JetspeedPrincipalQueryContext queryContext);

}