org.argeo.cms/src/org/argeo/cms/internal/auth/JcrSecurityModel.java

   1 /*
   2  * Copyright (C) 2007-2012 Argeo GmbH
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *         http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package org.argeo.cms.internal.auth;
  17
  18 import java.util.List;
  19
  20 import javax.jcr.Node;
  21 import javax.jcr.RepositoryException;
  22 import javax.jcr.Session;
  23
  24 /**
  25  * Manages data expected by the Argeo security model, such as user home and
  26  * profile.
  27  */
  28 public interface JcrSecurityModel {
  29         /** Initialize the JCR security model */
  30         public void init(Session adminSession) throws RepositoryException;
  31
  32         /**
  33          * To be called before user details are loaded. Make sure than any logged in
  34          * user has a home directory with full access and a profile with information
  35          * about him (read access)
  36          *
  37          * @return the user profile, never null
  38          */
  39         public Node sync(Session session, String username, List<String> roles);
  40 }