/**
* JBoss, Home of Professional Open Source
* Copyright 2011, Red Hat, Inc. and individual contributors
* by the @authors tag. See the copyright.txt in the distribution for a
* full listing of individual contributors.
*
* This is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as
* published by the Free Software Foundation; either version 2.1 of
* the License, or (at your option) any later version.
*
* This software is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.jboss.arquillian.ajocado.guard;
import org.jboss.arquillian.ajocado.framework.AjaxSelenium;
import org.jboss.arquillian.ajocado.request.RequestType;
/**
* The factory for shortening use of {@link RequestGuardInterceptor}s in code.
*
* @author <a href="mailto:lfryc@redhat.com">Lukas Fryc</a>
* @version $Revision$
*/
public final class RequestGuardFactory {
private RequestGuardFactory() {
}
/**
* Shortcut for registering a guard for specified request type on given selenium object.
*
* @param selenium
* where should be registered the given request type guard
* @param requestExpected
* the request type to be guarded if the expected request is allowed to be preceeded by another request
* type
* @return the selenium guarded to use XMLHttpRequest
*/
public static AjaxSelenium guard(AjaxSelenium selenium, RequestType requestExpected) {
if (requestExpected == null) {
return selenium;
}
AjaxSelenium copy = selenium.clone();
copy.getCommandInterceptionProxy().unregisterInterceptorType(RequestGuardInterceptor.class);
copy.getCommandInterceptionProxy().registerInterceptor(new RequestGuardInterceptor(requestExpected, false));
return copy;
}
/**
* <p>
* Shortcut for registering a guard for specified request type on given selenium object.
* </p>
*
* <p>
* This guard guards the right request type but allows interlaying of the request by another one of other type.
*
* @param selenium
* where should be registered the given request type guard
* @param requestExpected
* the request type to be guarded
* @return the selenium guarded to use XMLHttpRequest
*/
public static AjaxSelenium guardInterlayed(AjaxSelenium selenium, RequestType requestExpected) {
AjaxSelenium copy = selenium.clone();
copy.getCommandInterceptionProxy().unregisterInterceptorType(RequestGuardInterceptor.class);
copy.getCommandInterceptionProxy().registerInterceptor(new RequestGuardInterceptor(requestExpected, true));
return copy;
}
}