Commit 398c540f authored by Matija Obreza's avatar Matija Obreza
Browse files

JavaDoc updated

parent e23f2c1c
......@@ -66,9 +66,9 @@ public interface AuditLogCustomRepository {
/**
* Load entity from database by classname and id
*
* @param referencedClassPk
* @param previousState
* @return
* @param classPk classPK of the entity
* @param id the internal database id of the entity
* @return the persisted entity of type classPk
*/
Object get(ClassPK classPk, Long id);
......
......@@ -167,7 +167,7 @@ public class AccessToken implements Serializable {
* Get the clientId for which this token is issued.
*
* @return OAuth clientId
* @see {@link OAuthClient#getClientId()}
* @see OAuthClient#getClientId()
*/
public String getClientId() {
return clientId;
......
......@@ -141,7 +141,7 @@ public class RefreshToken implements Serializable {
* Get the clientId for which this token is issued.
*
* @return OAuth clientId
* @see {@link OAuthClient#getClientId()}
* @see OAuthClient#getClientId()
*/
public String getClientId() {
return clientId;
......
......@@ -42,17 +42,16 @@ public interface AclEntryPersistence extends JpaRepository<AclEntry, Long> {
/**
* List by SID and Object Identity
*
* @param sid
* @param objectIdentity
* @return
* @param sid - SID
* @param objectIdentity the ACL object identity
* @return list of ACL entries for specified SID and OID
*/
@Query("select ae from AclEntry ae where ae.aclSid = :aclSid and ae.aclObjectIdentity = :aclObjectIdentity")
List<AclEntry> findBySidAndObjectIdentity(@Param("aclSid") AclSid sid, @Param("aclObjectIdentity") AclObjectIdentity objectIdentity);
/**
/**
* Find IDs of object of aclClass for sid with specified permissions.
*
* /** Find IDs of object of aclClass for sid with specified permissions.
*
* @param sid - SID
* @param aclClass - class of domain object
......@@ -83,11 +82,13 @@ public interface AclEntryPersistence extends JpaRepository<AclEntry, Long> {
/**
* Delete AclEntries for a SID
*
* @param <T> type extending AclSid (User, OAuthClient)
* @param sid the SID
* @return number of deleted entries
*/
@Modifying
@Query("delete from AclEntry ae where ae.aclSid = :sid")
<T extends AclSid> int deleteForSid(@Param("sid") T sid);
}
......@@ -80,9 +80,9 @@ public interface BasicUserService<R extends GrantedAuthority, T extends BasicUse
* @param user the user
* @param email new email address
* @param fullName new fullName
* @return the t
* @return the updated user
* @throws NotUniqueUserException when email address is already registered
* @throws UserException
* @throws UserException a generic user service exception
*/
T updateUser(T user, String email, String fullName) throws NotUniqueUserException, UserException;
......@@ -91,7 +91,7 @@ public interface BasicUserService<R extends GrantedAuthority, T extends BasicUse
*
* @param user the user
* @param password new password
* @return the t
* @return the updated user
* @throws PasswordPolicyException the password policy exception
*/
T changePassword(T user, String password) throws PasswordPolicyException;
......
......@@ -33,7 +33,7 @@ public interface CustomAclService {
* Get SID by ID
*
* @param id -- ID of an AclSid entity
* @return
* @return persisted AclSid entity with specified id
*/
AclSid getSid(Long id);
......
......@@ -57,6 +57,8 @@ public class CurrentApplicationContext implements ApplicationContextAware {
/**
* Note that this is a static method which expose ApplicationContext
*
* @return the instance of the current Spring {@link ApplicationContext}
**/
public static ApplicationContext getContext() {
return applicationContext;
......
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