001/** 002 * 003 * Copyright (c) 2014, the Railo Company Ltd. All rights reserved. 004 * 005 * This library is free software; you can redistribute it and/or 006 * modify it under the terms of the GNU Lesser General Public 007 * License as published by the Free Software Foundation; either 008 * version 2.1 of the License, or (at your option) any later version. 009 * 010 * This library is distributed in the hope that it will be useful, 011 * but WITHOUT ANY WARRANTY; without even the implied warranty of 012 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 013 * Lesser General Public License for more details. 014 * 015 * You should have received a copy of the GNU Lesser General Public 016 * License along with this library. If not, see <http://www.gnu.org/licenses/>. 017 * 018 **/ 019package lucee.runtime.security; 020 021import lucee.runtime.converter.ScriptConvertable; 022import lucee.runtime.exp.PageException; 023 024/** 025 * Credential interface 026 */ 027public interface Credential extends ScriptConvertable{ 028 029 /** 030 * @return Returns the password. 031 */ 032 public abstract String getPassword(); 033 034 /** 035 * @return Returns the roles. 036 */ 037 public abstract String[] getRoles(); 038 039 /** 040 * @return Returns the username. 041 */ 042 public abstract String getUsername(); 043 044 /** 045 * encode rhe Credential to a Base64 String value 046 * @return base64 encoded string 047 * @throws PageException 048 */ 049 public abstract String encode() throws PageException; 050 051}