org.cobraparser.clientlet.Clientlet Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of Cobra Show documentation

Cobra is the rendering engine designed for LoboBrowser

There is a newer version: 1.0.2

/*
Copyright 1994-2006 The Lobo Project. All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list
of conditions and the following disclaimer. Redistributions in binary form must
reproduce the above copyright notice, this list of conditions and the following
disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE LOBO PROJECT ``AS IS'' AND ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
EVENT SHALL THE FREEBSD PROJECT OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
OF THE POSSIBILITY OF SUCH DAMAGE.
 */
package org.cobraparser.clientlet;

/**
 * A clientlet processes a URL response and creates content renderable by a user
 * agent.
 *
 * @see ClientletSelector#select(ClientletRequest, ClientletResponse)
 */
public interface Clientlet {
  /**
   * This method is invoked by a clientlet engine to process a URL response.
   * After the response is processed, the clientlet should either set
   * displayable content via
   * {@link ClientletContext#setResultingContent(ComponentContent)} or redirect
   * navigation elsewhere.
   *
   * @param context
   *          An instance of ClientletContext which represents the current
   *          request context.
   * @throws ClientletException
   *           This may be thrown by a clientlet when there are document errors.
   */
  public void process(ClientletContext context) throws ClientletException;
}