org.ops4j.pax.web.service.whiteboard.SecurityConfigurationMapping Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of pax-web-api Show documentation

Pax Web is a OSGi Http Service based on Jetty 6. Detailed information to be found at http://wiki.ops4j.org/confluence/x/AYAz.

The newest version!

/*
 * 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 org.ops4j.pax.web.service.whiteboard;

import java.util.Collection;

/**
 * Single interface to register 3 security aspects of {@code web.xml} configuration:

 *     {@code }
 *     {@code }
 *     {@code }
 * 

 *
 * This mapping was created as the last one for the purpose of
 * Pax Web #1823 issue.
 *
 * In Pax Web 7 we had two methods (which are back in Pax Web 8, but only for compatibility purpose):

 *     org.ops4j.pax.web.service.WebContainer#registerLoginConfig()
 *     org.ops4j.pax.web.service.WebContainer#registerConstraintMapping()
 * 
 * However these were not atomic (or rather as atomic as it's rational), because both methods leads to restart
 * of the underlying context. When Whiteboard-registering a service with this interface, we can do everything
 * within single context restart.
 *
 * @author Grzegorz Grzybek
 */
public interface SecurityConfigurationMapping extends ContextRelated {

	// --- the  part

	/**
	 * Returns {@code /}
	 * @return
	 */
	String getAuthMethod();

	/**
	 * Returns {@code /}
	 * @return
	 */
	String getRealmName();

	/**
	 * Returns {@code //}
	 * @return
	 */
	String getFormLoginPage();

	/**
	 * Returns {@code //}
	 * @return
	 */
	String getFormErrorPage();

	// --- the  part

	/**
	 * Returns a collection of {@code } information.
	 * @return
	 */
	Collection getSecurityConstraints();

	// --- the  part

	/**
	 * Returns declared security roles ({@code /})
	 * @return
	 */
	Collection getSecurityRoles();

}