org.refcodes.web.BasicAuthObservable Maven / Gradle / Ivy

Go to download
// /////////////////////////////////////////////////////////////////////////////
// REFCODES.ORG
// /////////////////////////////////////////////////////////////////////////////
// This code is copyright (c) by Siegfried Steiner, Munich, Germany, distributed
// on an "AS IS" BASIS WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, and licen-
// sed under the following (see "http://en.wikipedia.org/wiki/Multi-licensing")
// licenses:
// -----------------------------------------------------------------------------
// GNU General Public License, v3.0 ("http://www.gnu.org/licenses/gpl-3.0.html")
// -----------------------------------------------------------------------------
// Apache License, v2.0 ("http://www.apache.org/licenses/TEXT-2.0")
// -----------------------------------------------------------------------------
// Please contact the copyright holding author(s) of the software artifacts in
// question for licensing issues not being covered by the above listed licenses,
// also regarding commercial licensing models or regarding the compatibility
// with other open source licenses.
// /////////////////////////////////////////////////////////////////////////////

package org.refcodes.web;

/**
 * An observable which notifies the registered {@link BasicAuthObserver} on
 * incoming HTTP Basic-Authentication requests. Possible extension (idea):
 * Provide means to add multiple {@link BasicAuthObserver} instances and invoke
 * them as of their locator pattern (provide an additional locator argument and
 * an "BasicAuthEndpoint" class).
 *
 * @param  the generic type
 */
public interface BasicAuthObservable> {

	/**
	 * Registers the {@link BasicAuthObserver} to handle incoming HTTP basic
	 * authentication requests.
	 *
	 * @param aObserver The observer to handle incoming HTTP basic
	 *        authentication requests.
	 * 
	 * @return the implementing instance as of the builder pattern
	 */
	B onBasicAuthRequest( BasicAuthObserver aObserver );

}