Commit 6f8adc31 authored by Matija Obreza's avatar Matija Obreza
Browse files

Update javadoc

- JAutodoc headers and members
parent cabd3831
/*
* Copyright 2017 Global Crop Diversity Trust
* Copyright 2018 Global Crop Diversity Trust
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
......
/*
* Copyright 2017 Global Crop Diversity Trust
* Copyright 2018 Global Crop Diversity Trust
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
......
/*
* Copyright 2017 Global Crop Diversity Trust
* Copyright 2018 Global Crop Diversity Trust
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
......
/*
* Copyright 2017 Global Crop Diversity Trust
* Copyright 2018 Global Crop Diversity Trust
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
......
/*
* Copyright 2017 Global Crop Diversity Trust
* Copyright 2018 Global Crop Diversity Trust
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
......
/*
* Copyright 2017 Global Crop Diversity Trust
* Copyright 2018 Global Crop Diversity Trust
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
......
/*
* Copyright 2017 Global Crop Diversity Trust
* Copyright 2018 Global Crop Diversity Trust
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
......
/*
* Copyright 2017 Global Crop Diversity Trust
* Copyright 2018 Global Crop Diversity Trust
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
......
/*
* Copyright 2017 Global Crop Diversity Trust
* Copyright 2018 Global Crop Diversity Trust
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
......@@ -151,8 +151,8 @@ public class AclSid extends AuditedVersionedModel {
/**
* Subclasses should override this method and return a sensible display name for
* the SID
*
* the SID.
*
* @return SID full name
*/
public String getFullName() {
......
......@@ -75,7 +75,8 @@ public abstract class BasicUser<R extends GrantedAuthority> extends AclSid imple
GOOGLE,
/** The system. */
SYSTEM,
/** Deleted user accounts */
/** Deleted user accounts. */
DELETED
}
......@@ -138,6 +139,9 @@ public abstract class BasicUser<R extends GrantedAuthority> extends AclSid imple
private Date lastLogin;
/**
* Instantiates a new basic user.
*/
public BasicUser() {
setPrincipal(true);
}
......
/*
* Copyright 2017 Global Crop Diversity Trust
* Copyright 2018 Global Crop Diversity Trust
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
......
/*
* Copyright 2017 Global Crop Diversity Trust
* Copyright 2018 Global Crop Diversity Trust
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
......@@ -40,8 +40,8 @@ public interface AclEntryPersistence extends JpaRepository<AclEntry, Long> {
List<AclEntry> findByObjectIdentity(@Param("aclObjectIdentity") AclObjectIdentity aclObjectIdentity);
/**
* List by SID and Object Identity
*
* List by SID and Object Identity.
*
* @param sid - SID
* @param objectIdentity the ACL object identity
* @return list of ACL entries for specified SID and OID
......@@ -81,8 +81,8 @@ public interface AclEntryPersistence extends JpaRepository<AclEntry, Long> {
List<AclSid> getSids(@Param("objectIdentity") AclObjectIdentity objectIdentity);
/**
* Delete AclEntries for a SID
*
* Delete AclEntries for a SID.
*
* @param <T> type extending AclSid (User, OAuthClient)
* @param sid the SID
* @return number of deleted entries
......
......@@ -38,7 +38,7 @@ public interface AclObjectIdentityPersistence extends JpaRepository<AclObjectIde
AclObjectIdentity findByObjectIdAndClassname(@Param("objectIdIdentity") long objectIdIdentity, @Param("aclClass") String aclClass);
/**
* Clear the parentObject of child OID that use this oID as parentObject
* Clear the parentObject of child OID that use this oID as parentObject.
*
* @param oID the object identifier ID
*/
......
/*
* Copyright 2017 Global Crop Diversity Trust
* Copyright 2018 Global Crop Diversity Trust
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
......@@ -46,7 +46,7 @@ public interface AclSidPersistence extends JpaRepository<AclSid, Long> {
List<AclSid> listById(@Param("ids") Iterable<Long> ids);
/**
* List SIDs of authorities (roles)
* List SIDs of authorities (roles).
*
* @return the list of {@link AclSid} for registered authorities
*/
......
/*
* Copyright 2017 Global Crop Diversity Trust
* Copyright 2018 Global Crop Diversity Trust
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
......
/*
* Copyright 2017 Global Crop Diversity Trust
* Copyright 2018 Global Crop Diversity Trust
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
......
/*
* Copyright 2017 Global Crop Diversity Trust
* Copyright 2018 Global Crop Diversity Trust
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
......@@ -26,19 +26,19 @@ import com.fasterxml.jackson.annotation.JsonIgnore;
*/
public class Permissions {
/** Allowed to create */
/** Allowed to create. */
public boolean create;
/** Allowed to read */
/** Allowed to read. */
public boolean read;
/** Allowed to write/modify */
/** Allowed to write/modify. */
public boolean write;
/** Allowed to delete */
/** Allowed to delete. */
public boolean delete;
/** Allowed to admin/manage */
/** Allowed to admin/manage. */
public boolean manage;
/* (non-Javadoc)
......@@ -56,8 +56,8 @@ public class Permissions {
}
/**
* Is Permissions granting the {@link BasePermission} by its mask?
*
* Is Permissions granting the {@link BasePermission} by its mask?.
*
* @param mask int value of Permission mask
* @return true if granting, false otherwise
* @throws UnsupportedOperationException if mask is not understood
......
/*
* Copyright 2017 Global Crop Diversity Trust
* Copyright 2018 Global Crop Diversity Trust
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
......@@ -26,11 +26,11 @@ import org.genesys.blocks.security.model.AclSid;
import com.google.common.collect.Lists;
/**
* Simple POJO for SID's permissions
* Simple POJO for SID's permissions.
*/
public class SidPermissions extends Permissions {
/** SID having these permisions */
/** SID having these permisions. */
public AclSid sid;
/**
......@@ -45,8 +45,8 @@ public class SidPermissions extends Permissions {
}
/**
* Get SID
*
* Get SID.
*
* @return SID of current permissions set
*/
public AclSid getSid() {
......
/*
* Copyright 2017 Global Crop Diversity Trust
* Copyright 2018 Global Crop Diversity Trust
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
......
/*
* Copyright 2017 Global Crop Diversity Trust
* Copyright 2018 Global Crop Diversity Trust
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment