001    /**
002     * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portal.security.ac;
016    
017    import com.liferay.portal.kernel.exception.PortalException;
018    import com.liferay.portal.kernel.exception.SystemException;
019    import com.liferay.portal.security.auth.AuthException;
020    import com.liferay.portal.security.auth.AuthVerifierResult;
021    
022    import java.lang.annotation.Annotation;
023    
024    import java.util.Map;
025    
026    import javax.servlet.http.HttpServletRequest;
027    import javax.servlet.http.HttpServletResponse;
028    
029    /**
030     * @author Raymond Aug??
031     */
032    public interface AccessControl {
033    
034            public void initAccessControlContext(
035                    HttpServletRequest request, HttpServletResponse response,
036                    Map<String, Object> settings);
037    
038            public void initContextUser(long userId) throws AuthException;
039    
040            public AuthVerifierResult.State verifyRequest()
041                    throws PortalException, SystemException;
042    
043            public AccessControlled NULL_ACCESS_CONTROLLED = new AccessControlled() {
044    
045                    @Override
046                    public Class<? extends Annotation> annotationType() {
047                            return AccessControlled.class;
048                    }
049    
050                    @Override
051                    public boolean guestAccessEnabled() {
052                            return false;
053                    }
054    
055                    @Override
056                    public boolean hostAllowedValidationEnabled() {
057                            return false;
058                    }
059    
060            };
061    
062    }