ContentBox Core API 1.6.0

contentbox.model.security
Interface ISecurityService

WEB-INF.cftags.interface
        extended by contentbox.model.security.ISecurityService
All Known Implementing Classes:
SecurityService

public interface ISecurityService
extends WEB-INF.cftags.interface

******************************************************************************* ContentBox - A Modular Content Platform Copyright 2012 by Luis Majano and Ortus Solutions, Corp www.gocontentbox.org | www.luismajano.com | www.ortussolutions.com ******************************************************************************* Apache License, Version 2.0 Copyright Since [2012] [Luis Majano and Ortus Solutions,Corp] 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. ******************************************************************************* This is the ContentBox Security Service needed for security to be implemented in ContentBox

Method Summary
 boolean authenticate(any username, any password)
          Verify if an author has valid credentials in our system
 boolean authorizeContent(any content, any password)
          Check to authorize a user to view a content entry or page
 Author getAuthorSession()
          Get an author from session, or returns a new empty author entity
 boolean isContentViewable(any content)
          Checks Whether a content entry or page is protected and user has credentials for it
 ISecurityService logout()
          Delete author session
 ISecurityService sendPasswordReminder(Author author)
          Send password reminder for an author
 ISecurityService setAuthorSession(Author author)
          Set a new author in session
 boolean userValidator(struct rule, [any messagebox], [any controller])
          User validator via security interceptor
 
Methods inherited from class WEB-INF.cftags.interface
None
 

Method Detail

authenticate

public boolean authenticate(any username, any password)
Verify if an author has valid credentials in our system.

Parameters:
username
password

authorizeContent

public boolean authorizeContent(any content, any password)
Check to authorize a user to view a content entry or page

Parameters:
content
password

getAuthorSession

public Author getAuthorSession()
Get an author from session, or returns a new empty author entity


isContentViewable

public boolean isContentViewable(any content)
Checks Whether a content entry or page is protected and user has credentials for it

Parameters:
content

logout

public ISecurityService logout()
Delete author session


sendPasswordReminder

public ISecurityService sendPasswordReminder(Author author)
Send password reminder for an author

Parameters:
author

setAuthorSession

public ISecurityService setAuthorSession(Author author)
Set a new author in session

Parameters:
author

userValidator

public boolean userValidator(struct rule, [any messagebox], [any controller])
User validator via security interceptor

Parameters:
rule
messagebox
controller

ContentBox Core API 1.6.0