-
Notifications
You must be signed in to change notification settings - Fork 5.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Provide abstraction for an Authenticated Principal
- Loading branch information
Showing
5 changed files
with
157 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
46 changes: 46 additions & 0 deletions
46
core/src/main/java/org/springframework/security/core/AuthenticatedPrincipal.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
/* | ||
* Copyright 2012-2017 the original author or authors. | ||
* | ||
* 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. | ||
*/ | ||
package org.springframework.security.core; | ||
|
||
import org.springframework.security.authentication.AuthenticationManager; | ||
|
||
/** | ||
* Representation of an authenticated <code>Principal</code> once an | ||
* {@link Authentication} request has been successfully authenticated | ||
* by the {@link AuthenticationManager#authenticate(Authentication)} method. | ||
* | ||
* Implementors typically provide their own representation of a <code>Principal</code>, | ||
* which usually contains information describing the <code>Principal</code> entity, | ||
* such as, first/middle/last name, address, email, phone, id, etc. | ||
* | ||
* This interface allows implementors to expose specific attributes | ||
* of their custom representation of <code>Principal</code> in a generic way. | ||
* | ||
* @author Joe Grandja | ||
* @since 5.0 | ||
* @see Authentication#getPrincipal() | ||
* @see org.springframework.security.core.userdetails.UserDetails | ||
*/ | ||
public interface AuthenticatedPrincipal { | ||
|
||
/** | ||
* Returns the name of the authenticated <code>Principal</code>. Never <code>null</code>. | ||
* | ||
* @return the name of the authenticated <code>Principal</code> | ||
*/ | ||
String getName(); | ||
|
||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
81 changes: 81 additions & 0 deletions
81
core/src/test/java/org/springframework/security/core/userdetails/UserDetailsTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,81 @@ | ||
/* | ||
* Copyright 2012-2017 the original author or authors. | ||
* | ||
* 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. | ||
*/ | ||
package org.springframework.security.core.userdetails; | ||
|
||
import org.junit.Test; | ||
import org.springframework.security.core.GrantedAuthority; | ||
import org.springframework.security.core.authority.AuthorityUtils; | ||
|
||
import java.util.Collection; | ||
|
||
import static org.assertj.core.api.Assertions.assertThat; | ||
|
||
/** | ||
* Tests {@link UserDetails} | ||
* | ||
* @author Joe Grandja | ||
*/ | ||
public class UserDetailsTest { | ||
|
||
@Test | ||
public void getNameWhenCalledThenDefaultToGetUsername() { | ||
UserDetails userDetails = new MockUserDetails("joeg"); | ||
assertThat(userDetails.getName()).isEqualTo(userDetails.getUsername()); | ||
} | ||
|
||
private class MockUserDetails implements UserDetails { | ||
private final String username; | ||
|
||
private MockUserDetails(String username) { | ||
this.username = username; | ||
} | ||
|
||
@Override | ||
public Collection<? extends GrantedAuthority> getAuthorities() { | ||
return AuthorityUtils.NO_AUTHORITIES; | ||
} | ||
|
||
@Override | ||
public String getPassword() { | ||
return null; | ||
} | ||
|
||
@Override | ||
public String getUsername() { | ||
return this.username; | ||
} | ||
|
||
@Override | ||
public boolean isAccountNonExpired() { | ||
return true; | ||
} | ||
|
||
@Override | ||
public boolean isAccountNonLocked() { | ||
return true; | ||
} | ||
|
||
@Override | ||
public boolean isCredentialsNonExpired() { | ||
return true; | ||
} | ||
|
||
@Override | ||
public boolean isEnabled() { | ||
return true; | ||
} | ||
} | ||
} |