org.esigate.wicket.container.WATError Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of esigate-wicket Show documentation

ESIGate components for Apache Wicket.

There is a newer version: 4.4

/*
 * 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.esigate.wicket.container;


import org.apache.wicket.Response;
import org.esigate.wicket.utils.WATNullResponse;

/**
 * A container for default content on error. It encloses a block which will be
 * displayed in the target content is not available.
 * 
 * 
 * Usage :
 * 
 * 
 * 
 * Page :
 * 
 * 
 * WATBlock block1  = new WATBlock( "block", "url/of/content" );

 * WATError error = new WATParam( "defaultError" );

 * 
 * block1.add( error);
 * 
 * 
 * 
 * HTML :
 * 
 * 
 * 
 * <div wicket:id='block1'>

 *   <div wicket:id='defaultError>

 *    Block content. Can be pure html or other wicket components.

 *   </div>

 *  
 *  </div>

 *  
 * 
 * @author Nicolas Richeton
 * @see WATTemplate
 * 
 */
public class WATError extends AbstractWatBufferedContainer {

	/**
	 * Serialization ID.
	 */
	private static final long serialVersionUID = 1L;

	private final Integer errorCode;

	/**
	 * Create a parameter block
	 * 
	 * @param id
	 *            - Must be unique in the page
	 */
	public WATError(String id, Integer errorCode) {
		super(id);
		this.errorCode = errorCode;
	}

	private String getBlockName() {
		if (errorCode == null) {
			return AbstractWatDriverContainer.WAT_ERROR_PREFIX;
		}

		return AbstractWatDriverContainer.WAT_ERROR_PREFIX + errorCode;
	}

	@Override
	protected void process(String content) {
		Response r = getResponse();
		if (r instanceof WATNullResponse) {
			WATNullResponse watResponse = (WATNullResponse) r;

			// Add param content to parent template.
			watResponse.getBlocks().put(getBlockName(), content);
		} else {
			throw new RuntimeException(
					"WATError can only be used within a AbstractWatDriverContainer.");
		}

	}
}