|
Apache CXF API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.cxf.sts.token.renewer.SAMLTokenRenewer
public class SAMLTokenRenewer
A TokenRenewer implementation that renews a (valid or expired) SAML Token.
Field Summary | |
---|---|
static long |
DEFAULT_MAX_EXPIRY
|
Constructor Summary | |
---|---|
SAMLTokenRenewer()
|
Method Summary | |
---|---|
boolean |
canHandleToken(ReceivedToken renewTarget)
Return true if this TokenRenewer implementation is able to renew a token. |
boolean |
canHandleToken(ReceivedToken renewTarget,
String realm)
Return true if this TokenRenewer implementation is able to renew a token in the given realm. |
ConditionsProvider |
getConditionsProvider()
Get the ConditionsProvider |
long |
getMaxExpiry()
Get how long a token is allowed to be expired for before renewal (in seconds). |
Map<String,SAMLRealm> |
getRealmMap()
Get the map of realm->SAMLRealm for this token provider |
boolean |
isAllowRenewalAfterExpiry()
Get whether we allow renewal after expiry. |
boolean |
isSignToken()
Return whether the provided token will be signed or not. |
TokenRenewerResponse |
renewToken(TokenRenewerParameters tokenParameters)
Renew a token given a TokenRenewerParameters |
void |
setAllowRenewalAfterExpiry(boolean allowRenewalAfterExpiry)
Set whether we allow renewal after expiry. |
void |
setConditionsProvider(ConditionsProvider conditionsProvider)
Set the ConditionsProvider |
void |
setMaxExpiry(long newExpiry)
Set a new value (in seconds) for how long a token is allowed to be expired for before renewal. |
void |
setRealmMap(Map<String,SAMLRealm> realms)
Set the map of realm->SAMLRealm for this token provider |
void |
setSignToken(boolean signToken)
Set whether the provided token will be signed or not. |
void |
setVerifyProofOfPossession(boolean verifyProofOfPossession)
Set whether proof of possession is required or not to renew a token |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final long DEFAULT_MAX_EXPIRY
Constructor Detail |
---|
public SAMLTokenRenewer()
Method Detail |
---|
public boolean canHandleToken(ReceivedToken renewTarget)
canHandleToken
in interface TokenRenewer
public boolean canHandleToken(ReceivedToken renewTarget, String realm)
canHandleToken
in interface TokenRenewer
public void setVerifyProofOfPossession(boolean verifyProofOfPossession)
setVerifyProofOfPossession
in interface TokenRenewer
public boolean isAllowRenewalAfterExpiry()
public void setAllowRenewalAfterExpiry(boolean allowRenewalAfterExpiry)
setAllowRenewalAfterExpiry
in interface TokenRenewer
public void setMaxExpiry(long newExpiry)
public long getMaxExpiry()
public TokenRenewerResponse renewToken(TokenRenewerParameters tokenParameters)
renewToken
in interface TokenRenewer
public void setConditionsProvider(ConditionsProvider conditionsProvider)
public ConditionsProvider getConditionsProvider()
public boolean isSignToken()
public void setSignToken(boolean signToken)
public void setRealmMap(Map<String,SAMLRealm> realms)
realms
- the map of realm->SAMLRealm for this token providerpublic Map<String,SAMLRealm> getRealmMap()
|
Apache CXF API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |