1 /**
2 * Copyright (C) 2005-2009 Alfresco Software Limited.
3 *
4 * This file is part of the Spring Surf Extension project.
5 *
6 * Licensed under the Apache License, Version 2.0 (the "License");
7 * you may not use this file except in compliance with the License.
8 * You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing, software
13 * distributed under the License is distributed on an "AS IS" BASIS,
14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15 * See the License for the specific language governing permissions and
16 * limitations under the License.
17 */
18
19 package org.springframework.extensions.webscripts;
20
21 import org.springframework.extensions.webscripts.Description.RequiredAuthentication;
22
23 /**
24 * Web Script Authenticator for the HTTP Servlet environment
25 *
26 * @author davidc
27 */
28 public interface Authenticator
29 {
30 /**
31 * Authenticate Web Script execution
32 *
33 * @param required required level of authentication
34 * @param isGuest is Guest accessing the web script
35 *
36 * @return true if authorised to execute the script, false otherwise
37 */
38 public boolean authenticate(RequiredAuthentication required, boolean isGuest);
39
40 /**
41 * Are credentials set in the request ?
42 *
43 * @return true if credentials are empty
44 * @since 3.2
45 */
46 public boolean emptyCredentials();
47 }